Skip to main content

Create a Document

warning

As noted in the Documentation Guide, we have 3 separate document instances: 'Development', 'Documentation', and 'Guide'.

Make sure you are adding a document to the correct instance. This tutorial is editing the "Documentation" (/doc) instance as an example, which is for Release documentation. If you are planning on adding to pre-release, you should add documents to the "Development" (/dev) instance instead.

Documents are groups of pages connected through:

  • a sidebar
  • previous/next navigation
  • versioning

Create your first Doc

Create a Markdown file at docs/hello.md:

docs/hello.md
# Hello

This is my **first Docusaurus document**!

A new document is now available at http://localhost:3000/docs/hello.

Configure the Sidebar

Docusaurus automatically creates a sidebar from the docs folder.

Add metadata to customize the sidebar label and position:

docs/hello.md
---
sidebar_label: 'Hi!'
sidebar_position: 3
---

# Hello

This is my **first Docusaurus document**!

It is also possible to create your sidebar explicitly in sidebars.js:

sidebars.js
export default {
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
};