A barebones Docusaurus site.
To configure the CMS, a cloudcannon.config.yml file has been created at the root of the repository. This contains the following sections:
In collections_config.docs we specify a docs collection. This will be shown in the CloudCannon sidebar and will allow editors to make changes within this collection.
To match Docusaurus' default URL behavior, we use the [full_slug] url placeholder.
These URLs are used in the CloudCannon interface for opening previews and generating screenshots.
In paths we specify the path for both our uploads and static directories. This ensures that assets uploaded in CloudCannon will be placed inside the static directory, and will be linked relative to the same directory.
| editor's file | uploaded file | output url |
|---|---|---|
| image.png | static/image.png | /image.png |
In _editables.content we specify the toolbar options that editors will see in the CloudCannon Content Editor.
To read the full documentation for
cloudcannon.config.*files, see Setting global configuration at the CloudCannon Documentation.
-
When connecting this repository to CloudCannon, choose the
Otheroption for your static site generator. When prompted for Command Line Options, use the following values:field value Install Command npm i Build Command npm run build Output Path build mkdocsis already installed on the CloudCannon build image, so the install command is only needed for our theme. If you removedtheme: materialfrommkdocs.yml, you could leave the install field blank.buildis the default directory that Docusaurus will use for its output. Additionally, addingnode_modules/in Preserved Paths will help speed up subsequent builds.
That's all — once your site builds you will be able to browse, edit, and add to the docs collection in CloudCannon.