Skip to main content

Create a document

All documentation is stored in individual documents. Documents cover one specific topic in one specific category. You can navigate between categories in the navigation bar, and navigate between documents within that category in the left sidebar. Within a document, you can navigate between sections by scrolling or by using the right sidebar.

Create a new document​

Create a Markdown file at docs/your_category/document_name.md. A basic document contains a title and some text:

docs/your_category/document_name.md
# Title

Some text in your document!

The new document will appear in the left sidebar after saving it and uploading it to GitHub.

Configure the sidebar​

The left sidebar is automatically created from the docs folder. You can add metadata to customize the sidebar label and document ordering in the sidebar at the top of your Markdown document:

docs/your_category/document_name.md
---
sidebar_label: "This label will appear in the left sidebar"
sidebar_position: 3
---

Remainder of your content.