跳到主要内容

创建文档

文档页面通常通过以下方式组织:

  • 侧边栏导航
  • 上一页 / 下一页
  • 版本管理

创建第一篇文档

docs/hello.md 新建文件:

docs/hello.md
# 你好

这是我的第一篇 Docusaurus 文档。

访问地址: http://localhost:3000/docs/hello

配置侧边栏

Docusaurus 会根据 docs 目录自动生成侧边栏。

你也可以通过 Front Matter 自定义标题与排序:

docs/hello.md
---
sidebar_label: '你好'
sidebar_position: 3
---

# 你好

这是我的第一篇 Docusaurus 文档。

如果需要更复杂的结构,可以在 sidebars.js 中手动配置:

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