Skip to main content
Version: current

Project files

Makersaurus requires certain files and folders to be present. These files can be created manually or you can create them automatically by running the create-new-project command.

There are some optional files and folders whose presence will enable certain features - these are described below.

Required files​

makersaurus.config.js​

The primary file for configuring a Makersaurus project. See the Config docs for more info.

/docs​

Contains project markdown files. Follows the exact same format as a normal Docusaurus project. See the home page configuration guide for information about configuring index.md.

sidebars.js or sidebars.json​

Defines the sidebar for a given project. Follows the exact same format as a normal Docusaurus project.

Optional files​

app_banner.png​

If present, this banner will be used on the project home page. If absent a default H2O.ai banner will be used. The default image resolution is 600 by 282 pixels, supplying a custom image of significantly greater size will increase home page load times.

/static​

Add static assets (images and text files) here if needed. For more information see the Docusaurus static asset documentation.

Version files​

Enable versioning by including a versioned_docs folder, a versioned_sidebars folder, and a versions.json file. See the Versioning docs for more info.

Feedback