Skip to main content

创建一篇文档

文档是通过以下方式相互关联的一组页面

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

创建你的第一篇文档

docs/hello.md 路径下创建一个 Markdown 文件:

docs/hello.md
# 你好

这是我的**第一篇 Docusaurus 文档**

现在,你可以在 http://localhost:3000/docs/hello 访问这篇新文档了。

配置侧边栏

Docusaurus 会根据 docs 文件夹的内容自动生成侧边栏

你可以通过添加元数据来自定义侧边栏中的显示名称和排序位置:

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'],
},
],
};