mdx-components.js
使用 @next/mdx
與 App Router 時,mdx-components.js|tsx
檔案是必要的,沒有它將無法運作。此外,您還可以用它來自訂樣式。
在專案根目錄建立 mdx-components.tsx
(或 .js
) 檔案來定義 MDX 元件。例如,放在與 pages
或 app
同層級的位置,或是放在 src
目錄內(如果適用)。
匯出項目
useMDXComponents
函式
此檔案必須匯出單一函式,可以是預設匯出或命名為 useMDXComponents
。
參數
components
定義 MDX 元件時,匯出函式接受單一參數 components
。此參數是 MDXComponents
的實例。
- 鍵 (key) 是要覆寫的 HTML 元素名稱
- 值 (value) 是要替換渲染的元件
須知:請記得傳遞所有其他未覆寫的元件(即
...components
)。
版本歷史
版本 | 變更內容 |
---|---|
v13.1.2 | 新增 MDX 元件功能 |