Skip to main content

Contributing Docs

This document describes how to add and update markdown content that is presented in this Docusaurus 2 project.

The static documentation content displayed on this site can be found in the /docs folder within the project itself. The folder contains markdown files which are rendered in the Docusaurus 2 UI.

The markdown files used in this project need to contain a header with additional information about the file. You can see an example header here:

---
id: toc
title: Table of Contents
sidebar_label: TOC
---

Links to other documents within the docs folder should contain the path to the document. For example the following links to the modeling.md file in the modeling folder under docs.

[Modeling](_overview/modeling/modeling.md_)

For a full list of formatting syntax supported by Docusarus, you can visit this site.

Docusaurus 2 also supports MDX, a format that lets you seamlessly write JSX in your Markdown documents. You can find out more by visiting MDX, and you can see an example in this project here.

Adding Your Page to the Left Navigation​

To add a new page to the left navigation, you can add it to the sidebars.js file in the /website folder in the project. Details for customizing this sidebar file can be found here.

module.exports = {
  someSidebar: {
    Documentation: ['toc', 'overview/introduction/introduction',
    'overview/quick_start/quick_start', 'overview/modeling/modeling',
    'overview/inference/inference', 'overview/analysis/analysis']
  },
};