跳至主要内容

Docusaurus 流程圖繪製

@docusaurus/theme-mermaid 是 Docusaurus 將 Mermain 整併的流程圖套件,此套件可以生成 svg 圖檔。
供嵌入網頁使用

theme-mermaid 流程圖套件

套件安裝

    npm install @docusaurus/theme-mermaid

套件設定

docusaurus.config.js

  • Theme 可選擇:
    • default:
    • neutral: 列印黑白文件用
    • dark:
    • forest: 綠色色調
    • base: 欲客製化修改時選用

config 下加上下列三項設定

    const config = {
//簡易流程圖 meramaid 1/3
themes: ['@docusaurus/theme-mermaid'],

//簡易流程圖 meramaid 2/3
markdown: {
mermaid: true,
},

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
//簡易流程圖 meramaid 3/3
mermaid: {
// 你可以在這裡設定 Mermaid 的選項 (optional)
theme: {light: 'neutral', dark: 'forest'},
},

// omit....
}),
};

基本語法 in mdx

以 code block 封裝流程,語言選 mermaid

```mermaid %%{init: {'theme':'dark'}}%% graph TD; A-->B; A-->C; B-->D; C-->D; ```

基本語法 in jsx component

以 code block 封裝流程,語言選 mermaid

    import Mermaid from '@theme/Mermaid';

<Mermaid
value={`graph TD;
A-->B;
A-->C;
B-->D;
C-->D;`}
/\>

參考資料

範例

```mermaid graph TD A[開始] --> B{判斷}; B -- 是 --> C[處理]; B -- 否 --> D[結束]; C --> D; ```