创建文档
创建 markdown 文档,文件名为 greeting.md
,并将该文档放置于 docs
目录下。
在文档顶部的 front matter 中设置 id
和 title
属性,以便 Docusaurus 在生成您的网站时能够正确地识别该文件。
在浏览器中的渲染效果如下:This will render in the browser as follows:
http://localhost:3000
来自 Docusaurus 的问候
您准备好为您的开源项目创建文档站点了吗?
标题
标题将显示在右上方的目录中
以便用户无需向下滚动,甚至无需阅读更多内容,便可了解此页的梗概。
只有 h2 和 h3 标签作为目录展示
良好的标题间距,让文章结构更清晰。
- lists will help you
- present the key points
- that you want your users to remember
- and you may nest them
- multiple times
- and you may nest them