設定

nuxt.config.ts 中使用 contentMermaid 鍵設定套件選項:

export default defineNuxtConfig({
  contentMermaid: {
    loader: { lazy: true },
    theme: { light: 'default', dark: 'dark' },
  },
})

一般設定

選項類型預設值用途
enabledbooleantrue在 Nuxt 啟動時啟用模組與 Markdown 轉換。
debugbooleanfalse啟用更詳細的套件診斷資訊。

enabled 是建置時的模組選項。請將它放在 contentMermaid 下,而不是公開執行階段設定中。

載入與 Mermaid 初始化

選項類型預設值用途
loader.lazyboolean 或選項物件enabled等到圖表進入視窗後才載入。設定為 false 可立即載入。
loader.lazy.thresholdnumber套件未提供值設定 IntersectionObserver 的可見性門檻。
loader.init純資料 Mermaid 設定套件預設值將初始化選項傳給 Mermaid。

頁面與圖表的覆寫方式請參考撰寫圖表

主題

選項類型預設值用途
theme.lightMermaid 主題名稱default淺色模式使用的主題。
theme.darkMermaid 主題名稱dark深色模式使用的主題。

安裝 @nuxtjs/color-mode 後,渲染器會跟隨目前的色彩模式。也可以使用 useMermaidTheme() 控制目前使用的模式。

自訂元件

選項類型預設值用途
components.renderer元件名稱內建渲染器以應用程式元件取代圖表渲染。
components.spinner元件名稱提供載入中的元件。
components.error元件名稱提供渲染錯誤元件。

請使用 Nuxt 應用程式中元件的註冊名稱。如果無法解析自訂渲染器名稱,套件會退回使用內建渲染器。

展開

設定 expand: false 可停用展開,設定 expand: true 可使用所有預設值,也可以提供選項物件:

選項類型預設值用途
expand.enabledbooleantrue啟用展開互動。
expand.marginnumber0在展開後的圖表周圍保留指定像素數的邊距。
expand.invokeOpenOn.diagramClickbooleantrue點擊圖表時開啟覆蓋層。
expand.invokeCloseOn.escbooleantrue按下 Escape 時關閉。
expand.invokeCloseOn.wheelbooleantrue滾輪操作時關閉。
expand.invokeCloseOn.swipebooleantrue滑動時關閉。
expand.invokeCloseOn.overlayClickbooleantrue點擊覆蓋層背景時關閉。
expand.invokeCloseOn.closeButtonClickbooleantrue顯示並啟用關閉按鈕。

工具列

選項類型預設值用途
toolbar.titlestringmermaid設定工具列標題的預設值。
toolbar.fontSizestringnumber14px設定工具列字型大小。
toolbar.fullscreenToolbarScalenumber1.25在全螢幕模式中縮放工具列文字與圖示。
toolbar.buttons.copybooleantrue顯示複製來源碼按鈕。
toolbar.buttons.fullscreenbooleantrue顯示全螢幕按鈕。
toolbar.buttons.expandbooleantrue顯示展開按鈕。

Mermaid 負責的設定

loader.init、頁面設定與元件直接設定都會將值傳給 Mermaid,但此套件不會重新定義 Mermaid 的選項結構或行為。關於原生主題、圖表選項、安全性設定與指令,請使用官方的 Mermaid 設定文件