Markdown 链接
添加指向另一个页面的链接有两种方法:通过 URL 路径 和 文件路径 。
- [指向另一个文档的 URL 路径](./installation)
- [指向另一个文档的文件路径](./installation.mdx)
Docusaurus 不会处理 URL 路径,您可以将其视为直接渲染为 <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 编辑器中继续工作
- 您可以自定义文件的 slug,无需更新所有链接
- 移动文件夹周围的文件可以由您的编辑器跟踪,并且某些编辑器可能会自动更新文件链接
- 版本化文档 将链接到另一个相同版本的文档
- 如果您更新
trailingSlash
配置 ,相对 URL 链接很可能会中断
注意
只有当源文件和目标文件由同一个插件实例处理时,Markdown 文件引用才有效。这是我们 Markdown 处理架构的一个技术限制,将来会修复。如果您在插件之间链接文件(例如,从博客文章链接到文档页面),则必须使用 URL 链接。