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:

Property	Type	Required	Reference
baseUrl	string		Docusaurus docs
dependencies	object		Read below
deploymentBranch	string		Docusaurus docs
blog	object		Blog docs
breadcrumbs	boolean		Doc-page breadcrumbs, on by default; set false to turn off. Features guide
disableVersioning	boolean		Versioning docs
feedbackAssignee	string		Features guide
feedbackLabels	array		Features guide
groupBlogSidebarByVersion	boolean		Group the blog sidebar by minor-version series instead of by year, for changelog blogs; off by default. Blog docs
groupVersionDropdownByMinor	boolean | string		Group the version dropdown by minor series; off by default. "dividers" (or true) draws divider lines between groups, "nested" collapses each series into one expandable row. Features guide
imageZoom	boolean | object		Features guide
includeCurrentVersions	boolean		Versioning docs
lastVersion	string		Versioning docs
markdown	object		Docusaurus markdown options; set { math: true } for KaTeX math or { mermaid: true } for diagrams. Docusaurus docs
oldVersionsHref	string		Features guide
projectName	string	*	Docusaurus docs
redocusaurus	object		Features guide
searchFilter	string		Features guide
tagline	string	*	Docusaurus docs
title	string	*	Docusaurus docs
themes	object		Docusaurus docs
versionCustomField	string		Features guide
url	string		Docusaurus docs
versions	object		Versioning docs

Dependencies config

The dependencies object allows you to specify npm packages that you want to use in your docs. For example, to render videos in documentation using react-player, you can add that package to the dependencies object like so:

dependencies: {
  "react-player": "^2.11.0"
},

The format is the exact same as in package.json. You can add as many dependencies as you want, though just like any other project remember that installing too many dependencies leads to poor performance.

---

Feedback

• Submit and view feedback for this page
• Send feedback about Makersaurus Docs to cloud-feedback@h2o.ai