mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-30 18:58:36 +02:00
3d05ec2e4b
* update examples script * rename ext * typo * update examples * fix script to update starters * update examples * add --allow-empty so that script does not fail if nothing changed * fix lint
55 lines
952 B
Markdown
55 lines
952 B
Markdown
---
|
|
sidebar_position: 2
|
|
---
|
|
|
|
# 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`:
|
|
|
|
```md title="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 metadatas to customize the sidebar label and position:
|
|
|
|
```md title="docs/hello.md" {1-4}
|
|
---
|
|
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`:
|
|
|
|
```diff title="sidebars.js"
|
|
module.exports = {
|
|
tutorialSidebar: [
|
|
{
|
|
type: 'category',
|
|
label: 'Tutorial',
|
|
- items: [...],
|
|
+ items: ['hello'],
|
|
},
|
|
],
|
|
};
|
|
```
|