Markdown 链接
有两种添加链接到另一个页面的方式:通过 URL 路径 和 文件路径。
- [URL 路径到另一个文档](./installation)
- [文件路径到另一个文档](./installation.mdx)
URL 路径不会被 Docusaurus 处理,您可以将它们视为直接渲染为 <a href="./installation">
,即它将根据页面的 URL 位置进行解析,而不是其文件系统位置。
如果您想引用由同一插件包含的另一个 Markdown 文件,可以使用要链接到的文档的相对路径。Docusaurus 的 Markdown 加载器将文件路径转换为目标文件的 URL 路径(并因此删除 .md
扩展名)。
例如,如果您在 docs/folder/doc1.md
中,并且想引用 docs/folder/doc2.md
、docs/folder/subfolder/doc3.md
和 docs/otherFolder/doc4.md
:
docs/folder/doc1.md
我正在引用一个 [文档](doc2.mdx)。
引用另一个 [子文件夹中的文档](subfolder/doc3.mdx)。
[相对文档](../otherFolder/doc4.mdx) 引用也可以正常工作。
相对文件路径是相对于当前文件的目录解析的。另一方面,绝对文件路径是相对于内容根目录解析的,通常是 docs/
、blog/
,或者本地化的目录,如 i18n/zh-Hans/plugin-content-docs/current
。
绝对文件路径也可以相对于站点目录。但是,请注意,以 /docs/
或 /blog/
开头的链接不可移植,因为如果您创建新的文档版本或本地化它们,您需要手动更新它们。
您可以编写相对于内容根目录(`/docs/`)的 [链接](/otherFolder/doc4.mdx)。
您也可以编写相对于站点目录的 [链接](/docs/otherFolder/doc4.mdx),但不建议这样做。
使用相对的_文件_路径(带有 .md
扩展名)而不是相对的 URL 链接提供了以下好处:
- 链接将在 GitHub 界面和许多 Markdown 编辑器中继续工作
- 您可以自定义文件的别名而无需更新所有链接
- 在文件夹中移动文件可以被编辑器跟踪,一些编辑器可能会自动更新文件链接
- 版本化文档将链接到完全相同版本的另一个文档
- 如果您更新
trailingSlash
配置,相对 URL 链接很可能会中断
注意
Markdown 文件引用仅在源文件和目标文件由同一插件实例处理时才有效。这是我们 Markdown 处理架构的技术限制,将来会得到修复。如果您要在插件之间链接文件(例如从博客文章链接到文档页面),则必须使用 URL 链接。