跳到主要内容

文档功能简介

文档功能为用户提供了一种以层级结构组织 Markdown 文件的方法。

文档的 ID#

每份文档都对应了一个唯一的 id。默认情况下,文档的 id 就是该文档相对于文档根目录(即 docs 目录)的的文件名(不带扩展名)。

例如,greeting.md 的 id 是 greeting,而 guide/hello.md 的 id 是 guide/hello

website # 网站根目录
└── docs
   ├── greeting.md
└── guide
└── hello.md

但是,id最后一段 可以由用户在 front matter 中自定义。例如,如果 guide/hello.md 的内容如下所示,则其最终的 idguide/part1

---
id: part1
---
Lorem ipsum

如果你要对该文档所对应的 URL 的最后一段进行自定义的话,则可以添加一个 slug (默认与 id 一致)属性。

---
id: part1
slug: part1.html
---
Lorem ipsum
note

可以使用:

  • absolute slugs: slug: /mySlug, slug: /...
  • relative slugs: slug: mySlug, slug: ./../mySlug...

作为主页的文档#

如果你希望某份文档被放到根目录下,并且具有 https://docusaurus.io/docs/ 路径,则可以通过在 frontmatter 中设置 slug 属性为:

---
id: my-home-doc
slug: /
---
Lorem ipsum

仅文档展示模式#

如果你希望只使用文档功能,则可以让 Docusaurus 2 生成的网站不带落地页(landing page),而将文档页面作为落地页显示。

要启用该模式,请为文档插件设置 routeBasePath: '/',并为作为落地页的文档的 front matter 中设置 slug: /了解更多信息)。

caution

你还需要删除当前的 ./src/pages/index.js 页面,否则将有两个文件映射到同一个路由(或路径)上!

tip

对于只想使用 Docusaurus 2 的博客功能的用户,可以使用“仅博客模式”。用法与上面的“仅文档模式”类似。请参考 仅博客模式 的设置说明。