Objective: # 概念阐释 ## 创建文档 创建一个 Markdown 文件，`greeting.md`并将其放在该`docs`目录下。 ``` website # 你的网站的根目录 ├── docs │ └── greeting.md ├── src │ └── pages ├── docusaurus.config.js ├── ... ``` ## yaml区 frontmatter 前言用于为您的文档页面提供额外的元数据。前言是可选的——Docusaurus 能够自行推断所有必要的元数据，无需前言。例如，下面介绍的文档标签功能需要使用前言。有关所有可能的字段，请参阅 [API 文档](https://docusaurus.io/zh-CN/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter)。 ### 例子：一篇包含标签的文档 ``` --- id: doc-with-tags // title: 一篇包含标签的文档 tags: - 演示 - 开始上手 --- ``` #### `title` 侧边栏将显示这里的名称而不是文档的名称。例如文档叫做`hello.md`, `title：my document title`，浏览器将会显示title里的字符。 #### `id` 每个文档都有一个唯一的`id`，文档id默认情况下为文件名称： - `greeting.md`的id是`greeting` - `guide/hello.md`的id是`guide/hello`。 - 也可以自定义，例如`guide/hello.md`定义为`id: part1` #### [[slug]] 修改URL上的文件夹路径显示。默认情况下`hello.md`将在`/docs/guide/hello`. 您可以将其 URL 位置更改为`/docs/bonjour`： ``` --- slug: /bonjour --- ``` #### `sidebar_positon` 改变文件的位置。 #### `tags` 显示标签 ## 侧边栏 使用[自动生成的侧边栏](https://docusaurus.io/zh-CN/docs/sidebar/autogenerated)时，文件结构将决定侧边栏结构。 我们对文件系统组织的建议是：让你的文件系统镜像侧边栏结构（这样你就不需要手写你的`sidebars.js`文件），并使用`slug`front matter 来自定义每个文档的 URL。 # 实例 # 相关内容 和blog的区别是blog不提供文档分层，没有侧边栏，blog就是一个垂直浏览的博客页面。 # 参考资料 - [the API documentation-Mae Front matter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter). - [自动生成侧边栏](https://docusaurus.io/docs/sidebar/autogenerated) - [创建文档](https://docusaurus.io/docs/create-doc)