Skip to main content

文档插件的 Markdown 功能

文档插件可以使用任何常见的 Markdown 功能,并拥有一些特定于该文档插件的 markdown 功能。

Markdown frontmatter

Markdown 文档拥有自己特定的 Markdown frontmatter 属性

引用其它文档

如果需要引用另一个文档文件,则可以使用被引用文档的相对路径。

Docusaurus 会将文件路径转换为最终的网站 url 地址(并去掉 .md 扩展名)。

例如,如果你在 folder/doc1.md 中引用 folder/doc2.mdfolder/subfolder/doc3.mdotherFolder/doc4.md

I am referencing a [document](doc2.md).

Reference to another [document in a subfolder](subfolder/doc3.md).

[Relative document](../otherFolder/doc4.md) referencing works as well.
tip

使用相对文件路径优于相对链接,有以下原因:

  • GitHub 支持相对路径链接
  • 你可以自定义文档的 slug 属性,而无需更新所有链接
  • 版本化文档能够正确链接到相同版本中的另一份文档
  • 如果你修改了 trailingSlash 配置项,相对链接可能会无效,而相对路径则能够继续有效