Gerstep/excalidraw-diagram

Excalidraw Diagram Generator

Create Excalidraw diagrams from text content with multiple output formats.

Output Modes

根据用户的触发词选择输出模式：

| 触发词 | 输出模式 | 文件格式 | 用途 | |--------|----------|----------|------| | Excalidraw、画图、流程图、思维导图 | Obsidian（默认） | .md | 在 Obsidian 中直接打开 | | 标准Excalidraw、standard excalidraw | Standard | .excalidraw | 在 excalidraw.com 打开/编辑/分享 | | Excalidraw动画、动画图、animate | Animated | .excalidraw | 拖到 excalidraw-animate 生成动画 |

Workflow

1. Detect output mode from trigger words (see Output Modes table above)
2. Analyze content - identify concepts, relationships, hierarchy
3. Choose diagram type (see Diagram Types below)
4. Generate Excalidraw JSON (add animation order if Animated mode)
5. Output in correct format based on mode
6. Automatically save to current working directory
7. Notify user with file path and usage instructions

Output Formats

Mode 1: Obsidian Format (Default)

严格按照以下结构输出，不得有任何修改：

---
excalidraw-plugin: parsed
tags: [excalidraw]
---
==⚠  Switch to EXCALIDRAW VIEW in the MORE OPTIONS menu of this document. ⚠== You can decompress Drawing data with the command palette: 'Decompress current Excalidraw file'. For more info check in plugin settings under 'Saving'

# Excalidraw Data

## Text Elements
%%
## Drawing
\`\`\`json
{JSON 完整数据}
\`\`\`
%%

关键要点：

• Frontmatter 必须包含 tags: [excalidraw]
• 警告信息必须完整
• JSON 必须被 %% 标记包围
• 不能使用 excalidraw-plugin: parsed 以外的其他 frontmatter 设置
• 文件扩展名：.md

Mode 2: Standard Excalidraw Format

直接输出纯 JSON 文件，可在 excalidraw.com 打开：

{
  "type": "excalidraw",
  "version": 2,
  "source": "https://excalidraw.com",
  "elements": [...],
  "appState": {
    "gridSize": null,
    "viewBackgroundColor": "#ffffff"
  },
  "files": {}
}

关键要点：

• source 使用 https://excalidraw.com（不是 Obsidian 插件）
• 纯 JSON，无 Markdown 包装
• 文件扩展名：.excalidraw

Mode 3: Animated Excalidraw Format

与 Standard 格式相同，但每个元素添加 customData.animate 字段控制动画顺序：

{
  "id": "element-1",
  "type": "rectangle",
  "customData": {
    "animate": {
      "order": 1,
      "duration": 500
    }
  },
  ...其他标准字段
}

动画顺序规则：

• order: 动画播放顺序（1, 2, 3...），数字越小越先出现
• duration: 该元素的绘制时长（毫秒），默认 500
• 相同 order 的元素同时出现
• 建议顺序：标题 → 主要框架 → 连接线 → 细节文字

使用方法：

1. 生成 .excalidraw 文件
2. 拖到 https://dai-shi.github.io/excalidraw-animate/
3. 点击 Animate 预览，然后导出 SVG 或 WebM

文件扩展名：.excalidraw

---

Diagram Types & Selection Guide

选择合适的图表形式，以提升理解力与视觉吸引力。

| 类型 | 英文 | 使用场景 | 做法 | |------|------|---------|------| | 流程图 | Flowchart | 步骤说明、工作流程、任务执行顺序 | 用箭头连接各步骤，清晰表达流程走向 | | 思维导图 | Mind Map | 概念发散、主题分类、灵感捕捉 | 以中心为核心向外发散，放射状结构 | | 层级图 | Hierarchy | 组织结构、内容分级、系统拆解 | 自上而下或自左至右构建层级节点 | | 关系图 | Relationship | 要素之间的影响、依赖、互动 | 图形间用连线表示关联，箭头与说明 | | 对比图 | Comparison | 两种以上方案或观点的对照分析 | 左右两栏或表格形式，标明比较维度 | | 时间线图 | Timeline | 事件发展、项目进度、模型演化 | 以时间为轴，标出关键时间点与事件 | | 矩阵图 | Matrix | 双维度分类、任务优先级、定位 | 建立 X 与 Y 两个维度，坐标平面安置 | | 自由布局 | Freeform | 内容零散、灵感记录、初步信息收集 | 无需结构限制，自由放置图块与箭头 |

Design Rules

Text & Format

• 所有文本元素必须使用 fontFamily: 5（Excalifont 手写字体）
• 文本中的双引号替换规则：" 替换为 『』
• 文本中的圆括号替换规则：() 替换为 「」
• 字体大小规则：
  • 标题：24-28px
  • 副标题：18-20px
  • 正文/说明：14-16px
• 行高：所有文本使用 lineHeight: 1.25

Layout & Design

• 画布范围：建议所有元素在 0-1200 x 0-800 区域内
• 元素间距：确保元素间距适当，整体布局美观
• 层次清晰：使用不同颜色和形状区分不同层级的信息
• 图形元素：适当使用矩形框、圆形、箭头等元素来组织信息
• 禁止 Emoji：不要在图表文本中使用任何 Emoji 符号，如需视觉标记请使用简单图形（圆形、方形、箭头）或颜色区分

Color Palette

• 标题颜色：#1e40af（深蓝）
• 副标题/连接线：#3b82f6（亮蓝）
• 正文文字：#374151（灰色）
• 强调/重点：#f59e0b（金色）
• 其他配色：建议使用和谐的配色方案，避免过多颜色

参考：references/excalidraw-schema.md

JSON Structure

Obsidian 模式：

{
  "type": "excalidraw",
  "version": 2,
  "source": "https://github.com/zsviczian/obsidian-excalidraw-plugin",
  "elements": [...],
  "appState": { "gridSize": null, "viewBackgroundColor": "#ffffff" },
  "files": {}
}

Standard / Animated 模式：

{
  "type": "excalidraw",
  "version": 2,
  "source": "https://excalidraw.com",
  "elements": [...],
  "appState": { "gridSize": null, "viewBackgroundColor": "#ffffff" },
  "files": {}
}

Element Template

Each element requires these fields (do NOT add extra fields like frameId, index, versionNonce, strokeStyle, rawText -- they cause "invalid file" errors on excalidraw.com v0.17.0+):

{
  "id": "unique-id",
  "type": "rectangle",
  "x": 100, "y": 100,
  "width": 200, "height": 50,
  "angle": 0,
  "strokeColor": "#1e1e1e",
  "backgroundColor": "transparent",
  "fillStyle": "solid",
  "strokeWidth": 2,
  "roughness": 1,
  "opacity": 100,
  "groupIds": [],
  "roundness": {"type": 3},
  "seed": 123456789,
  "version": 1,
  "isDeleted": false,
  "boundElements": null,
  "updated": 1,
  "link": null,
  "locked": false
}

Text elements add:

{
  "text": "显示文本",
  "fontSize": 20,
  "fontFamily": 5,
  "textAlign": "center",
  "verticalAlign": "middle",
  "containerId": null,
  "originalText": "显示文本",
  "autoResize": true,
  "lineHeight": 1.25
}

Animated 模式额外添加 customData 字段：

{
  "id": "title-1",
  "type": "text",
  "customData": {
    "animate": {
      "order": 1,
      "duration": 500
    }
  },
  ...其他字段
}

See references/excalidraw-schema.md for all element types.

---

Additional Technical Requirements

Text Elements 处理

• ## Text Elements 部分在 Markdown 中必须留空，仅用 %% 作为分隔符
• Obsidian ExcaliDraw 插件会根据 JSON 数据自动填充文本元素
• 不需要手动列出所有文本内容

坐标与布局

• 坐标系统：左上角为原点 (0,0)
• 推荐范围：所有元素在 0-1200 x 0-800 像素范围内
• 元素 ID：每个元素需要唯一的 id（可以是字符串，如「title」「box1」等）

Required Fields for All Elements

IMPORTANT: Do NOT include frameId, index, versionNonce, strokeStyle, or rawText fields. These cause "Error: invalid file" on excalidraw.com v0.17.0+. Use boundElements: null (not []), and updated: 1 (not timestamps).

{
  "id": "unique-identifier",
  "type": "rectangle|text|arrow|ellipse|diamond",
  "x": 100, "y": 100,
  "width": 200, "height": 50,
  "angle": 0,
  "strokeColor": "#color-hex",
  "backgroundColor": "transparent|#color-hex",
  "fillStyle": "solid",
  "strokeWidth": 2,
  "roughness": 1,
  "opacity": 100,
  "groupIds": [],
  "roundness": {"type": 3},
  "seed": 123456789,
  "version": 1,
  "isDeleted": false,
  "boundElements": null,
  "updated": 1,
  "link": null,
  "locked": false
}

Text-Specific Properties

文本元素 (type: "text") 需要额外属性（do NOT include rawText）：

{
  "text": "显示文本",
  "fontSize": 20,
  "fontFamily": 5,
  "textAlign": "center",
  "verticalAlign": "middle",
  "containerId": null,
  "originalText": "显示文本",
  "autoResize": true,
  "lineHeight": 1.25
}

appState 配置

"appState": {
  "gridSize": null,
  "viewBackgroundColor": "#ffffff"
}

files 字段

"files": {}

Implementation Notes

Auto-save & File Generation Workflow

当生成 Excalidraw 图表时，必须自动执行以下步骤：

1. 选择合适的图表类型

• 根据用户提供的内容特性，参考上方 「Diagram Types & Selection Guide」 表
• 分析内容的核心诉求，选择最合适的可视化形式

2. 生成有意义的文件名

根据输出模式选择文件扩展名：

| 模式 | 文件名格式 | 示例 | |------|-----------|------| | Obsidian | [主题].[类型].md | 商业模式.relationship.md | | Standard | [主题].[类型].excalidraw | 商业模式.relationship.excalidraw | | Animated | [主题].[类型].animate.excalidraw | 商业模式.relationship.animate.excalidraw |

• 优先使用中文以提高清晰度

3. 使用 Write 工具自动保存文件

• 保存位置：当前工作目录（自动检测环境变量）
• 完整路径：{current_directory}/[filename].md
• 这样可以实现灵活迁移，无需硬编码路径

4. 确保 Markdown 结构完全正确

必须按以下格式生成（不能有任何修改）：

---
excalidraw-plugin: parsed
tags: [excalidraw]
---
==⚠  Switch to EXCALIDRAW VIEW in the MORE OPTIONS menu of this document. ⚠== You can decompress Drawing data with the command palette: 'Decompress current Excalidraw file'. For more info check in plugin settings under 'Saving'

# Excalidraw Data

## Text Elements
%%
## Drawing
\`\`\`json
{完整的 JSON 数据}
\`\`\`
%%

5. JSON 数据要求

• 包含完整的 Excalidraw JSON 结构
• 所有文本元素使用 fontFamily: 5
• 文本中的 " 替换为 『』
• 文本中的 () 替换为 「」
• JSON 格式必须有效，通过语法检查
• 所有元素有唯一的 id
• 包含 appState 和 files: {} 字段

6. 用户反馈与确认

向用户报告：

• 图表已生成
• 精确的保存位置
• 如何在 Obsidian 中查看
• 图表的设计选择说明（选择了什么类型的图表、为什么）
• 是否需要调整或修改

Example Output Messages

Obsidian 模式：

Excalidraw 图已生成！

保存位置：商业模式.relationship.md

使用方法：
1. 在 Obsidian 中打开此文件
2. 点击右上角 MORE OPTIONS 菜单
3. 选择 Switch to EXCALIDRAW VIEW

Standard 模式：

Excalidraw 图已生成！

保存位置：商业模式.relationship.excalidraw

使用方法：
1. 打开 https://excalidraw.com
2. 点击左上角菜单 → Open → 选择此文件
3. 或直接拖拽文件到 excalidraw.com 页面

Animated 模式：

Excalidraw 动画图已生成！

保存位置：商业模式.relationship.animate.excalidraw

动画顺序：标题(1) → 主框架(2-4) → 连接线(5-7) → 说明文字(8-10)

生成动画：
1. 打开 https://dai-shi.github.io/excalidraw-animate/
2. 点击 Load File 选择此文件
3. 预览动画效果
4. 点击 Export 导出 SVG 或 WebM