文档插件的 Markdown 功能

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

Markdown frontmatter#

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

引用其它文档#

如果需要引用另一个文档文件,则可以使用被引用文档的文件名。Docusaurus 会将文件路径转换为最终的网站路径(并去掉 .md 扩展名)。

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

引用一份 [文档](doc1.md)。再引用另一份 [放在目录下的文档](folder/doc3.md)
引用 [相对路径的文档](../doc2.md) 也没问题。

这种方式的一个好处是,如果你在 GitHub 上查看文件时,指向外部文件的链接仍然有效。

另一个好处是,对于版本化的文档来说,同一个版本中的文档将链接到相同版本的另一份文档。