Create a Document
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
module.exports = {
tutorialSidebar: [
{
type: 'category',
label: 'Tutorial',
- items: [...],
+ items: ['hello'],
},
],
};
- npm
- Yarn
npm install @docusaurus/remark-plugin-npm2yarn
yarn add @docusaurus/remark-plugin-npm2yarn