Markdown 連結
有兩種方式可以新增指向其他頁面的連結:透過URL 路徑和檔案路徑。
- [URL path to another document](./installation)
- [file path to another document](./installation.mdx)
Docusaurus 沒有處理 URL 路徑,你可以將它們視為直接呈示為 <a href="./installation">
,亦即它會根據頁面的網址位置來解析,而不是它的檔案系統位置。
如果你要參照由同個外掛程式包含的其他 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
I am referencing a [document](doc2.mdx).
Reference to another [document in a subfolder](subfolder/doc3.mdx).
[Relative document](../otherFolder/doc4.mdx) referencing works as well.
對應檔案路徑會解析成目前檔案的目錄。另一方面,絕對檔案路徑會解析成對應於內容根目錄,通常是 docs/
、blog/
或 在地化檔案,例如 i18n/zh-Hans/plugin-content-docs/current
。
絕對檔案路徑也可以對應於網站目錄。但請注意,若連結開頭是 /docs/
或 /blog/
,這類連結不可攜帶,因為你在建立新的文件版本或本地化時,需要手動更新這些連結。
You can write [links](/otherFolder/doc4.mdx) relative to the content root (`/docs/`).
You can also write [links](/docs/otherFolder/doc4.mdx) relative to the site directory, but it's not recommended.
使用相對檔案路徑(有 .md
附檔名),而非相對URL 連結,可獲得以下好處:
- 連結在 GitHub 介面和許多 Markdown 編輯器上仍會運作
- 你可以自訂檔案的 Slug,而不必更新所有連結
- 移動檔案時,你的編輯器可以追蹤移動的動作,而且有些編輯器可能會自動更新檔案連結
- 已版本控管的文件 會連結到同一個版本的另一個文件
- 如果你更新
trailingSlash
設定檔,那麼相對 URL 連結很可能會中斷
警告
Markdown 檔案參照僅在來源檔和目標檔經過同一個外掛程式執行時,才會運作。此為我們的 Markdown 處理器架構的技術限制,我們會在未來修正此限制。如果你想在不同的外掛程式間連結檔案(例如:從部落格文章連結到文件頁面),則必須使用 URL 連結。