跳至內容
Fumadocs

Remark Show

依條件顯示內容。

使用方式

Remark Show 是用於 <show> 語法的 remark 外掛。Fumadocs MDX、@fumadocs/astro 與本機 Markdown 皆預設啟用此外掛。

當 when 表達式為 true 時,<show> 會算繪其內容。表達式會在頁面算繪時求值,因此可以讀取頁面的 props,例如路徑參數。若 <show> 未指定 when,將無法通過編譯。

頁面資料

未算繪的內容同樣不會納入頁面資料,包括目錄、標題 ID、結構化資料以及處理後的 Markdown。

這些資料來自 Rehype 目錄、Remark Structure 和 Remark LLMs。若未使用 Fumadocs MDX,它們會在編譯時期產生資料, 此時任何條件都尚未求值,因此含有 <show> 的文件 會編譯失敗。若使用自訂內容來源,請啟用執行階段 輸出。

步驟與頁籤群組

<show> 可以包裹一個步驟,或是頁籤群組中的程式碼區塊。請參閱範例。

  • 在外掛設定中,請將 Remark Show 放在 Remark 步驟與 remarkCodeTab 之前。
  • 請至少保留一個步驟或一個頁籤在 <show> 之外,否則每個 <show> 都會各自形成獨立的步驟或頁籤群組。

How is this guide?

最後更新於