Skip to content

Repository files navigation

YiziMarkdown

YiziMarkdown

官方网站: https://md.yizigpt.com

一款简洁精致的跨平台 Markdown 编辑器,支持 Windows 便携版与 macOS 版本。免安装,解压即用,兼顾颜值与实用。Windows 可安装,也可下载压缩包解压即用;macOS 提供通用二进制安装包,Intel 与 Apple Silicon 均原生运行。

为什么要开发一款 Markdown 编辑器?

市面上不少 Markdown 编辑器,要么界面观感欠佳,要么功能繁杂臃肿,很难找到一款兼顾简洁美观、上手顺手的编辑工具。

于是便有了 YiziMarkdown。

我们为所见即所得模式,创造了一种极为优雅的体验;同时支持类 PPT 快捷演示能力,写好的笔记文档可以快速切换演示模式,方便做分享汇报。试过才知道。


功能特性

编辑与预览

  • 源代码编辑:CodeMirror 6 内核,语法高亮、括号匹配、自动补全
  • 实时模式(WYSIWYG):所见即所得编辑,输入时自动隐藏 Markdown 标记,专注内容创作
  • 实时模式动画:4种标记显现动画方案(聚焦/闪光/辉光/涟漪),设置中可预览切换
  • 实时预览:Markdown 即写即渲染,支持任务列表 checkbox 交互
  • 五种视图模式:源代码 / 并排 / 实时(所见即所得) / 预览 / 演示(全屏幻灯片),一键切换
  • 大纲驱动滚动同步:并排模式下左右面板双向联动,切换视图时自动定位到当前位置
  • 搜索替换:支持匹配项导航、全部替换
  • 工具栏快捷格式:粗体、斜体、删除线、行内代码,选中文字即裹即用
  • 本地图片渲染:预览模式自动渲染本地路径图片(jpg/png/gif/webp/svg/bmp)
  • 行号 / 自动换行:均可在设置中开关

数学公式与图表

  • KaTeX 公式:内置 KaTeX 插件,行内 $...$ 和块级 $$...$$ LaTeX 公式实时渲染
  • Mermaid 图表:内置 Mermaid 插件,流程图、时序图、甘特图、类图、饼图等自动渲染为可视化图表,支持多种主题配置
  • 表格行列选择器:工具栏表格按钮打开 8×8 网格,鼠标点选即插入对应行列数的表格

演示模式(幻灯片)

  • 纯 Markdown 驱动:不需要任何额外格式,---(水平分割线)分页,引擎根据内容结构自动选择版式
  • 6 种自动版式:封面(# 标题)、内容(##/段落/列表/表格)、图片、引用、代码、图表(mermaid)
  • 居中排版:块居中、文字居中、列表左对齐,标题位置稳定不跳动
  • 主题继承:标题颜色随主题精确变化(15 个主题均支持),演示内可切换主题/明暗
  • 全屏切换:F 键全屏/还原,支持从任意窗口状态(普通/最大化)可靠进入
  • 演讲者备注<!-- notes: ... --> 注释,播放时按 S 显示

插件系统

  • 插件化架构,内置 KaTeX 和 Mermaid 两个核心插件
  • 设置面板「插件」页支持启停控制和插件配置
  • 插件按需动态加载,未启用不占用资源

多文件管理

  • 单实例模式:多文件打开不再启动多个窗口,自动合并到已有实例,重复打开的文件自动定位到对应标签页
  • Tab 标签栏:顶部管理多个打开的文件,切换、关闭、新建
  • 首页:最近打开的文件列表,含文件大小和修改时间
  • 保存状态指示:未保存文件呼吸圆点动画,保存后 ✅ 确认动画
  • 关闭确认:未保存文件关闭时弹出保存 / 不保存 / 取消确认

文件操作

  • 打开:支持 .md / .markdown / .txt
  • 新建:新建空白 Tab,显示「未命名新文件」
  • 从模板新建:工具栏「从模板新建」下拉菜单,按所选模板的 Markdown 结构创建新文档;也可在 设置 → 通用 设定默认模板,之后 Ctrl+N 自动套用
  • 保存 / 自动保存:手动保存 + 可配置间隔的自动保存(1~10 秒)
  • 另存为:新建文件保存时自动弹出另存为对话框
  • 导出:HTML / Markdown / 纯文本三种格式
  • .md 文件关联:设置中一键设为系统默认 Markdown 编辑器,双击 .md 直接打开(Windows 注册表 / macOS LaunchServices)
  • 命令行打开YiziMarkdown 文件路径.md 直接打开

外观定制

  • 七套内置主题:学术蓝(默认)、活力橙、科技感、极简风、杂志感、自然风、液态玻璃、荔枝红、紫罗兰、赛博朋克、Facebook、黑客帝国、薄荷冰沙、落日熔金、复古打字机,每套均有亮暗两套配色
  • 深色 / 亮色模式:每套主题均有亮暗两套配色
  • 字体自定义:源代码模式和预览模式分别设置字体、字号、行高
  • 自定义 CSSuser.css 覆盖在所有主题之后,优先级最高
  • 主题扩展themes/ 目录放入 .css 文件,重启后自动识别

其他

  • 文档模板templates/ 目录放入 .md 文件,新建时可选择
  • 快捷键系统:可视化快捷键配置面板,支持 30 个 action 的自定义绑定、按键录制、冲突检测和恢复默认
  • 设置面板:通用、外观、编辑器、实时模式、关于等多个标签页,设置即时预览

快捷键

快捷键 功能
Ctrl+N 新建文件
Ctrl+O 打开文件
Ctrl+S 保存文件
Ctrl+Shift+S 另存为
Ctrl+W 关闭标签
Ctrl+H 导出 HTML
Ctrl+M 导出 Markdown
Ctrl+Z 撤销
Ctrl+Y 重做
Ctrl+F 搜索
Ctrl+\ 切换侧边栏
Ctrl+B 粗体
Ctrl+I 斜体
Ctrl+- 删除线
Ctrl++ 行内代码
Ctrl+1 一级标题
Ctrl+2 二级标题
Ctrl+3 三级标题
Ctrl+. 无序列表
Ctrl+0 有序列表
Ctrl+' 引用
Ctrl+K 链接
Ctrl+` 代码块
Ctrl+T 表格
Ctrl+L 分割线
F1 快捷键大全
F2 切换深浅模式
F3 循环切换视图
Ctrl+Alt+P 演示模式(幻灯片)
Ins 斜杠菜单
F12 开发者工具

快捷键可在 设置 → 快捷键 中自定义,支持可视化配置和冲突检测。


便携版目录结构

YiziMarkdown/
├── YiziMarkdown.exe        # 主程序
├── readme.md               # 项目说明(本文件)
├── welcome.md              # 欢迎文档
├── changelog.md            # 开发日志
├── user.css                # 用户自定义样式
├── keybindings.json        # 快捷键配置
├── themes/                 # 主题 CSS 文件
│   ├── academic.css        # 学术蓝(默认)
│   ├── vibrant.css         # 活力橙
│   ├── tech.css            # 科技感
│   ├── minimal.css         # 极简风
│   ├── magazine.css        # 杂志感
│   └── nature.css          # 自然风
└── templates/              # 文档模板
    └── default.md          # 默认模板

技术栈

层级 技术
桌面框架 Tauri 2 (Rust)
前端框架 React 18 + TypeScript
编辑器内核 CodeMirror 6
状态管理 Zustand (persist)
样式方案 Tailwind CSS + CSS 变量
Markdown 渲染 markdown-it
构建工具 Vite

开发

环境要求

  • Node.js 18+
  • Rust (stable)
  • Tauri CLI (npm install -g @tauri-apps/cli)

启动开发服务器

cd code
npm install
npm run tauri:dev

构建发布版

Windows

npm run tauri:build

构建产物:

  • 便携版 exe:src-tauri/target/release/yizimarkdown.exe
  • MSI 安装包:src-tauri/target/release/bundle/msi/
  • NSIS 安装包:src-tauri/target/release/bundle/nsis/

构建后手动复制 exe 和资源文件到 public/YiziMarkdown-vX.X.X/ 目录分发。

macOS(通用二进制,同时支持 Intel 与 Apple Silicon)

rustup target add aarch64-apple-darwin
npm run tauri:build -- --target universal-apple-darwin

构建产物:

  • 应用包:src-tauri/target/universal-apple-darwin/release/bundle/macos/YiziMarkdown.app
  • 安装包:src-tauri/target/universal-apple-darwin/release/bundle/dmg/YiziMarkdown_0.1.8_universal.dmg

项目结构

code/
├── src/                    # 前端源码
│   ├── App.tsx             # 主应用组件
│   ├── components/         # UI 组件
│   │   ├── Editor.tsx      # CodeMirror 编辑器 + 预览
│   │   ├── TabBar.tsx      # Tab 标签栏
│   │   ├── HomePage.tsx    # 首页(最近文件)
│   │   ├── Toolbar.tsx     # 工具栏
│   │   ├── Sidebar.tsx     # 侧栏(大纲 + 文件浏览)
│   │   ├── StatusBar.tsx   # 底部状态栏
│   │   └── SettingsModal.tsx # 设置面板
│   ├── stores/             # Zustand 状态管理
│   ├── lib/                # 工具库(markdown 渲染、标题 ID)
│   └── styles/             # 全局样式
├── src-tauri/              # Rust 后端
│   ├── src/main.rs         # Tauri 命令(文件读写、主题加载、注册表等)
│   ├── icons/              # 应用图标
│   ├── themes/             # 主题 CSS
│   └── templates/          # 文档模板
└── package.json

许可

MIT

About

YiziMarkdown是一款精致的 Windows 便携 Markdown 编辑器,兼顾美观与实用。

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages