MarkdownEditer

一个轻量级、美观的跨平台 Markdown 编辑器，基于 Tauri + React + Milkdown 构建。

✨ 特性

核心功能

• ⚡ 即时渲染 - WYSIWYG 编辑体验，输入即渲染
• 📂 多标签页 - 同时编辑多个文件
• 🗺️ 大纲导航 - 自动识别标题，快速跳转
• 🔗 大纲联动 - 编辑区滚动时自动高亮当前标题，并同步滚动侧栏
• 💾 智能保存 - 自动识别变更，支持快捷键保存
• 📖 本地文件编辑 - 支持打开、编辑、保存本地 Markdown 文件
• 🧩 语法快捷插入 - 侧栏语法项可点击插入，常见语法支持直接渲染命令
• 🔎 搜索与替换 - 支持当前文档搜索、替换、结果计数与正文高亮
• 🎨 美观界面 - 支持浅色/暗色主题自动切换与手动切换
• 🌐 跨平台 - 支持 macOS、Windows、Linux

Markdown 支持

• ✅ 标准 Markdown 语法
• ✅ GFM 扩展（表格、任务列表、代码高亮）
• ✅ Mermaid 流程图、时序图、甘特图
• ✅ 数学公式模板插入
• ✅ 标题 / 粗体 / 斜体 / 删除线 / 列表 / 引用 / 分割线 快捷命令
• ✅ 局部源码编辑（标题 / 段落 / 列表 / 引用 / 代码块 / 表格）
• ✅ 主题模式切换（浅色 / 深色 / 跟随系统）
• ✅ 当前文档搜索、替换与搜索高亮

🚀 获取与安装

默认推荐直接从 GitHub Releases 下载现成安装包，而不是本地自行构建。

• 下载地址： GitHub Releases
• 当前发布会提供桌面端安装包，优先选择与你系统对应的版本：
  • macOS
  • Windows

macOS 首次打开说明

当前 Release 中的 macOS 安装包尚未接入 Apple Developer 签名与 notarization，首次运行时可能被系统提示“已损坏”或“不受信任”。这通常不是文件真的损坏，而是 Gatekeeper 拦截。

处理方式见：

• macOS 首次运行说明

🧪 本地开发

只有在需要参与开发、调试或自行打包时，才需要本地构建。

开发环境

# 安装依赖
npm install

# 启动开发模式
npm run tauri dev

# 构建生产版本
npm run tauri build

系统要求

• Node.js >= 18
• Rust >= 1.70 (安装 Rust)

⌨️ 快捷键

快捷键	功能
Cmd/Ctrl + N	新建文件
Cmd/Ctrl + O	打开文件
Cmd/Ctrl + S	保存文件
Cmd/Ctrl + W	关闭标签页
Cmd/Ctrl + F	打开当前文档搜索
Cmd/Ctrl + Z	撤销

🛠 技术栈

前端

• React 19 - UI 框架
• TypeScript - 类型安全
• Vite - 构建工具
• Milkdown - 基于 ProseMirror 的 Markdown 编辑器

后端

• Tauri 2.x - 跨平台桌面框架
• Rust - 原生性能，安全可靠
• Tauri Plugins - 文件操作、对话框等

📁 项目结构

mdediter/
├── src/                      # 前端代码
│   ├── components/           # React 组件
│   │   ├── Editor.tsx        # Markdown 编辑器
│   │   └── Sidebar.tsx       # 侧边栏（大纲/语法参考）
│   ├── App.tsx               # 主应用组件
│   ├── App.css               # 全局样式
│   └── main.tsx              # 应用入口
├── src-tauri/                # Tauri 后端代码
│   ├── src/
│   │   ├── lib.rs            # Rust 逻辑
│   │   └── main.rs           # 应用入口
│   ├── tauri.conf.json       # Tauri 配置
│   └── Cargo.toml            # Rust 依赖
├── package.json              # 前端依赖
└── README.md                 # 项目说明

📝 开发进度

✅ 已完成

• 基础 Tauri + React 项目搭建
• Milkdown 编辑器集成
• 即时渲染编辑体验
• GFM 语法支持
• Mermaid 图表支持
• 多标签页功能
• 文件操作（新建/打开/保存）
• 左侧侧边栏
• 大纲导航与跳转
• 大纲与编辑区双向联动
• Markdown 语法参考
• 语法点击插入与常见语法快捷命令
• 文件夹浏览
• 文件夹内 Markdown 文件点击打开
• 快捷键支持
• 搜索与替换（当前文档）
• 搜索结果计数与正文高亮
• 本地 Markdown 文件打开/保存稳定性修复
• 标题与普通段落双击进入局部 Markdown 编辑态
• 浅色/暗色主题自动切换与手动切换
• 设置弹窗（主题、页宽、快捷键、开发信息）
• 页宽固定档位切换（阅读 / 标准 / 宽屏）
• HTML 导出

🔄 开发中

• 数学公式实时渲染（KaTeX）
• 编辑器设置（字体、行高等）
• 拼写检查
• 右键菜单
• 图片插入交互优化

📅 计划中

• 同步功能（iCloud/Dropbox）
• 版本历史
• 协作编辑
• 移动端支持

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📚 开发记录

近期开发进度已同步到 DEVELOPMENT_LOG.md，用于记录编辑器交互、语法插入、文件打开稳定性等阶段性变更。

📄 许可证

MIT License