Skip to content

caseclose/mymd-editor

Repository files navigation

MyMD

Typora 风格的 Windows Markdown 编辑器

面向个人写作与效率提升 · 开源项目,欢迎交流与自用

Feng Wang Gmail PKU Mail

所见即所得 · 专注写作 · 丰富导出

主界面

三栏布局:文件树 · 编辑区 · 大纲

License: MIT Electron React TypeScript


为什么选择 MyMD?

🖊️ 沉浸式写作 专注 / 打字机模式,减少干扰
📂 项目级管理 打开文件夹、侧边栏文件树、实时刷新
🧭 结构化导航 右侧大纲,一键跳转标题
📑 多标签编辑 多文档并行、关闭恢复、浏览器式快捷键
📤 多格式导出 PDF · HTML · PNG · Word · EPUB
🎨 可定制外观 亮/暗主题 + 导入自定义 CSS

界面预览

写作体验

亮色主界面

日常写作默认视图,简洁克制。

亮色主界面

暗色主题

Ctrl+Alt+T 一键切换,夜间更护眼。

暗色主题

专注模式

F8 淡化非当前段落,聚焦思路。

专注模式

打字机模式

F9 让光标始终停留在舒适视线位置。

打字机模式

源码模式

Ctrl+/ 在 WYSIWYG 与 Markdown 源码间切换。

源码模式

状态栏

字数统计、缩放控制、路径、自动保存与模式指示。

状态栏

导航与组织

多标签页

Ctrl+T 新建标签,Ctrl+W 关闭,Ctrl+Shift+T 恢复最近关闭的标签。

崩溃恢复

自动保存会话快照,异常退出后启动可恢复未保存内容。

文件树侧边栏

Ctrl+Shift+O 打开文件夹,快速切换文档。

文件树

大纲面板

Ctrl+Shift+L 切换,长文结构一目了然。

大纲面板

查找与替换

Ctrl+F / Ctrl+H,支持区分大小写与批量替换。

查找替换

富文本能力

数学公式

KaTeX 渲染行内与块级公式。

数学公式

Mermaid 图表

流程图、时序图等直接写在文档里。

Mermaid

代码高亮

CodeMirror 驱动,多语言语法着色。

代码高亮

图片嵌入

上传至文档旁 assets/ 目录,本地引用。

图片嵌入

自定义主题

导入 .css 主题文件,打造个人风格。

自定义主题

导出

导出菜单

PDF / HTML / 无样式 HTML / PNG / Word / EPUB。

导出菜单

PDF 导出

基于打印引擎,适合分享与归档。

PDF 导出

Word / EPUB 导出需要安装 Pandoc


功能清单

类别 功能
编辑 GFM 所见即所得、源码模式、撤销/重做、编辑器缩放
标签 多标签页、关闭恢复(Ctrl+Shift+T)、Ctrl+19 切换
写作 专注模式 F8、打字机模式 F9、自动保存(30s)、崩溃恢复
导航 文件树、大纲、查找/替换
富内容 KaTeX、Mermaid、代码高亮、图片相对路径
外观 亮/暗主题、自定义 CSS 主题、MyMD 品牌图标
导出 PDF、HTML、PNG、Word(Pandoc)、EPUB(Pandoc)
系统 无边框窗口、.md 文件关联、单实例打开

快速开始

开发

git clone https://github.com/caseclose/mymd-editor.git
cd mymd-editor
npm install
npm run dev
# 若 dev 异常或白屏,可先清理进程:
npm run dev:clean

构建安装包

npm run build        # 编译
npm run build:win    # 打包 Windows 安装程序 → release/

测试

npm test

快捷键

文件

操作 快捷键
新建 Ctrl+N
打开 Ctrl+O
打开文件夹 Ctrl+Shift+O
保存 Ctrl+S
另存为 Ctrl+Shift+S
导出 PDF Ctrl+Shift+E

标签页

操作 快捷键
新建标签页 Ctrl+T
关闭标签页 Ctrl+W
关闭窗口 Ctrl+Shift+W
恢复已关闭标签 Ctrl+Shift+T
下一个 / 上一个标签 Ctrl+Tab / Ctrl+Shift+Tab
按序号切换标签 Ctrl+1Ctrl+9

视图与编辑

操作 快捷键
切换主题 Ctrl+Alt+T
切换侧边栏 Ctrl+\
切换大纲 Ctrl+Shift+L
放大 / 缩小 / 重置缩放 Ctrl+= / Ctrl+- / Ctrl+0
专注模式 F8
打字机模式 F9
源码模式 Ctrl+/
查找 Ctrl+F
替换 Ctrl+H

按住 Ctrl 并滚动鼠标滚轮也可缩放编辑区。


技术栈

Electron 37  +  electron-vite  +  React 19  +  TypeScript
        ↓
@milkdown/crepe (WYSIWYG)  +  Tailwind CSS  +  electron-builder
模块 用途
@milkdown/crepe WYSIWYG Markdown 内核
KaTeX 数学公式
Mermaid 图表
chokidar 文件夹监听
Pandoc(可选) Word / EPUB 导出

许可证

MIT

About

Typora-style Markdown editor for Windows (Electron + Milkdown)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors