Markdown Forge

一款专业的 Windows 桌面 Markdown 编辑器
支持 Mermaid 和 PlantUML 图表，打造极致写作体验

功能特性 • 下载安装 • 使用指南 • 开发

---

✨ 功能特性

📝 编辑器

• Monaco Editor - VS Code 同款专业代码编辑器
• 智能提示 - 语法高亮、自动补全
• 滚动同步 - 编辑区与预览区实时同步
• 自动保存 - 可配置自动保存间隔
• 字体定制 - 支持 Cascadia Code、Fira Code、JetBrains Mono 等
• 字号调节 - 小/中/大/超大四档可选

🎨 Markdown 渲染

• GitHub 风格 - 完整支持 GFM (GitHub Flavored Markdown)
• 代码高亮 - 支持 100+ 编程语言语法高亮
• 表格支持 - 美观的表格渲染，支持斑马纹
• 任务列表 - 可交互的 Todo 列表
• 图表支持 - Mermaid 流程图、时序图、类图等
• UML 图表 - PlantUML 支持，可自定义服务器

🖼️ 图表导出

• 右键菜单 - 在 Mermaid/PlantUML 图表上右键
• 复制图片 - 直接复制到剪贴板
• 导出 SVG - 矢量格式，无损缩放
• 导出 PNG - 2x 高清位图

🎭 界面体验

• 主题切换 - 亮色/暗色主题一键切换
• 主题预设 - 暗色 IDE / 亮色文档预设
• 全屏模式 - F11 沉浸式全屏
• Zen Mode - 隐藏工具栏，专注写作
• 大纲导航 - TOC 目录快速跳转
• Windows 11 风格 - 原生 Fluent Design 体验

📁 文件管理

• 拖放打开 - 拖拽 .md 文件直接打开
• 最近文件 - 快速访问历史文件
• 未保存提示 - 关闭前自动提醒保存

📥 下载安装

系统要求

• Windows 10/11 (64-bit)
• 推荐 4GB+ 内存

安装方式

1. 从 Releases 页面下载最新版 Markdown Forge Setup x.x.x.exe
2. 运行安装程序，按提示完成安装
3. 从开始菜单或桌面快捷方式启动

便携版

下载 win-unpacked.zip，解压后直接运行 Markdown Forge.exe

📖 使用指南

快捷键

快捷键	功能
F11	切换全屏
Ctrl+Shift+Z	切换 Zen Mode
Ctrl+Shift+O	切换大纲面板
Ctrl+O	打开文件
Ctrl+S	保存文件
Ctrl+Shift+S	另存为
Ctrl+F	查找
Ctrl+H	替换
Ctrl+Z	撤销
Ctrl+Y	重做

Mermaid 图表

在 Markdown 中使用 Mermaid 代码块：

```mermaid
graph TD
    A[开始] --> B{判断}
    B -->|是| C[执行]
    B -->|否| D[结束]
```

支持的图表类型：

• 流程图 (Flowchart)
• 时序图 (Sequence Diagram)
• 类图 (Class Diagram)
• 状态图 (State Diagram)
• 甘特图 (Gantt Chart)
• 饼图 (Pie Chart)
• 和更多...

PlantUML 图表

在 Markdown 中使用 PlantUML 代码块：

```plantuml
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi
@enduml
```

自定义 PlantUML 服务器：

1. 点击工具栏设置按钮
2. 在"服务"分组下修改服务器地址
3. 点击保存

图表导出

1. 将鼠标移动到任意 Mermaid 或 PlantUML 图表上
2. 右键点击打开上下文菜单
3. 选择：
   • 📋 复制图片 - 复制到剪贴板
   • 💾 另存为 SVG - 保存矢量图
   • 🖼️ 另存为 PNG - 保存高清图片

🛠️ 开发

环境要求

• Node.js 18+
• npm 9+

本地开发

# 克隆仓库
git clone https://github.com/yourusername/markdown-forge.git
cd markdown-forge

# 安装依赖
npm install

# 启动开发服务器
npm run dev

构建打包

# 构建生产版本
npm run build

# 打包为 Windows 安装程序
npm run build:electron

打包后的文件位于 dist_electron 目录：

• Markdown Forge Setup x.x.x.exe - NSIS 安装程序
• win-unpacked/ - 便携版

📁 项目结构

markdown-forge/
├── build/                  # 构建资源
│   └── icon.png           # 应用图标
├── electron/               # Electron 主进程
│   ├── main.ts            # 主进程入口
│   ├── preload.ts         # 预加载脚本
│   ├── fileSystem.ts      # 文件操作
│   └── settingsStore.ts   # 设置存储
├── src/                    # 前端 React 代码
│   ├── App.tsx            # 主应用组件
│   ├── api/               # IPC 通信
│   ├── components/        # UI 组件
│   │   ├── EditorPane     # Monaco 编辑器
│   │   ├── PreviewPane    # Markdown 预览
│   │   ├── OutlinePanel   # 大纲面板
│   │   └── ...
│   ├── markdown/          # Markdown 渲染
│   │   ├── MermaidBlock   # Mermaid 渲染
│   │   └── PlantUMLBlock  # PlantUML 渲染
│   └── styles/            # 样式文件
├── package.json
└── vite.config.ts

🔧 技术栈

• 框架: Electron 28 + React 18 + TypeScript
• 构建: Vite 5 + electron-builder
• 编辑器: Monaco Editor
• Markdown: react-markdown + remark-gfm
• 代码高亮: react-syntax-highlighter
• 图表: Mermaid + PlantUML
• 存储: electron-store

📄 许可证

MIT License - 详见 LICENSE

---

Made with ❤️ for Markdown lovers