Skip to main content
Version: v0.0.4

Makersaurus Config

You need a makersaurus.config.js file in the project root to successfully generate a site. Most properties have docusaurus.config.js equivalents and are just copied over - you can refer to the Docusaurus configuration docs for great documentation about exactly what these fields do. Fields specific to Makersaurus are more extensively documented below.

Schema​

makersaurus.config.js should export an object with the following properties:

PropertyTypeRequiredReference
titlestring*Docusaurus docs
taglinestring*Docusaurus docs
urlstring*Docusaurus docs
projectNamestring*Docusaurus docs
baseUrlstringDocusaurus docs
deploymentBranchstringDocusaurus docs
versionsobjectVersioning docs
homePageobject*See below

Home page​

The homePage object is deeply nested but simple to understand. The home page pictured below is produced from the following code:

homePage: {
title: "Welcome home!",
subtitle: "Are you thirsty? We have some H2O for you",
sections: [
{
title: "Documentation",
subsections: [
{
title: "Guides",
subtitle: "Learn how to drink water",
items: [
{
label: "Filling",
to: "/guides/filling",
},
{
label: "Sipping",
href: "https://h2o.ai/",
},
],
},
],
},
],
},

Home Page Example

You can add as many sections, subsections and items as needed. Note that subsection items have either a to or href property. Use the to property for internal links and the href property for external links.


Feedback