创建文档
创建名为 greeting.md
的 Markdown 文件,并放置于 docs
目录下。
website # 您站点的根目录├── docs│ └── greeting.md├── src│ └── pages├── docusaurus.config.js├── ...
在文件顶部的前言中指定 id
及 title
,Docusaurus 在生成站点时将自动使用此信息。
---id: greetingtitle: 您好---
## 来自 Docusaurus 的问候
您准备好为您的开源项目创建文档网站了吗?
### 页眉
将显示于右上方的目录
这样,您的用户不用通读全文即可知晓这篇文章的主要内容。
### 仅在目录中呈现 h2 及 h3
这些页眉间的间隔合适,文章内容得以清楚呈现。
- 列表将帮助您- 阐述让用户牢记的关键点 - 您还可以将其嵌套 - 很多次
### 自定义页眉 ID {#custom-id}
使用 `{#custom-id}` 语法,您可以设置自己的页眉 ID。
浏览器中的渲染效果如下:
http://localhost:3000
来自 Docusaurus 的问候
您准备好为您的开源项目创建文档网站了吗?
页眉
将显示于右上方的目录
这样,您的用户不用通读全文即可知晓这篇文章的主要内容。
仅在目录中呈现 h2 及 h3
这些页眉间的间隔合适,文章内容得以清楚呈现。
- 列表将帮助您
- 阐述让用户牢记的关键点
- 您还可以将其嵌套
- 很多次
- 您还可以将其嵌套