MKReader 是一个基于 Electron 开发的现代化 Markdown 文件阅读器,专为提供优雅的 Markdown 文档阅读体验而设计。它支持多标签页浏览、代码高亮、Mermaid 图表渲染、全屏阅读等丰富功能,是开发者和文档爱好者的理想选择。

• 📑 多标签页管理 - 同时打开多个 Markdown 文件,支持标签页切换和管理
• 🎨 实时渲染 - 基于 markdown-it 的高质量 Markdown 渲染
• 🔍 文档大纲 - 自动生成文档结构导航,快速跳转到任意章节
• 📁 文件关联 - 自动关联 .md 文件,双击即可打开

• 🌙 主题支持 - 支持明暗主题切换,护眼阅读
• 📏 响应式设计 - 自适应不同屏幕尺寸,提供最佳阅读体验
• 🎪 全屏模式 - 沉浸式阅读体验,专注内容
• 🎯 代码高亮 - 基于 Prism.js 的多语言语法高亮

• 🔄 实时渲染 - 支持 19+ 种 Mermaid 图表类型

  • 流程图 (Flowchart)
  • 序列图 (Sequence Diagram)
  • 类图 (Class Diagram)
  • 状态图 (State Diagram)
  • 甘特图 (Gantt Chart)
  • 饼图 (Pie Chart)
  • Git 图 (Git Graph)
  • 思维导图 (Mind Map)
  • 时间轴 (Timeline)
  • 等等...

• 🎛️ 交互控制

  • 缩放控制 (放大/缩小/适应屏幕)
  • 图表导出 (PNG/SVG 格式)
  • 代码复制和刷新
  • 响应式适配

• ⚙️ 丰富设置

  • 5 种内置主题 (default/neutral/dark/forest/base)
  • 显示选项自定义
  • 8 种常用模板示例
  • 设置自动保存

• 📤 多格式导出 - 支持 HTML、PDF 格式导出
• 🎨 样式保持 - 导出时保持原有样式和格式
• 🖼️ 图片处理 - 自动处理文档中的图片和图表

• ⚡ 快捷键支持 - 丰富的键盘快捷键
• 🔄 热重载 - 文件变化自动刷新
• 🐛 调试模式 - 内置开发者工具支持

• 操作系统: Windows 10/11, macOS 10.14+, Linux (Ubuntu 18.04+)
• 内存: 512MB 可用内存
• 磁盘空间: 200MB 可用空间

1. 前往 Releases 页面
2. 下载适合您操作系统的安装包
3. 运行安装程序并按提示完成安装

# 1. 克隆项目
git clone https://github.com/your-repo/mkreader.git
cd mkreader
# 2. 安装依赖
npm install
# 3. 启动开发模式
npm start
# 4. 构建应用 (可选)
npm run build

1. 启动 MKReader
2. 点击 "File" → "Open File" 或使用快捷键 Ctrl+O 打开 Markdown 文件
3. 也可以直接双击 .md 文件(如已关联文件类型)

在 Markdown 文档中使用以下语法创建图表:

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

• 菜单: Tools → Mermaid Diagram Settings
• 图表工具栏: 点击设置按钮

支持 190+ 种编程语言的语法高亮:

```javascript
function hello() {
 console.log("Hello, MKReader!");
}
```
```python
def fibonacci(n):
 if n <= 1:
 return n
 return fibonacci(n-1) + fibonacci(n-2)
```

1. 打开要导出的 Markdown 文件
2. 点击工具栏的导出按钮或使用 Ctrl+E
3. 选择导出格式 (HTML/PDF)
4. 选择保存位置

mkreader/
├── src/ # 源代码目录
│ ├── main.js # Electron 主进程
│ ├── preload.js # 预加载脚本
│ └── renderer/ # 渲染进程
│ ├── index.html # 主页面
│ ├── renderer.js # 渲染进程主逻辑
│ ├── tab-manager.js # 标签页管理
│ ├── outline.js # 大纲导航
│ ├── code-highlighter.js # 代码高亮
│ ├── mermaid-renderer.js # Mermaid 渲染器
│ ├── export-manager.js # 导出功能
│ └── *.css # 样式文件
├── assets/ # 资源文件
│ ├── icon.png # 应用图标
│ └── icons/ # 多尺寸图标
├── example/ # 示例文件
├── docs/ # 项目文档
└── package.json # 项目配置

# 安装依赖
npm install
# 启动开发模式
npm start
# 构建应用
npm run build
# 生成图标
npm run generate-icons

MKReader 采用模块化架构设计:

Main Process (main.js)
 ↓ IPC Communication
Renderer Process (renderer.js)
 ├── TabManager (标签管理)
 ├── OutlineNavigator (大纲导航)
 ├── CodeHighlighter (代码高亮)
 ├── MermaidRenderer (图表渲染)
 └── ExportManager (导出功能)

我们欢迎所有形式的贡献!

1. Fork 本项目
2. 创建 特性分支 (git checkout -b feature/AmazingFeature)
3. 提交 更改 (git commit -m 'Add some AmazingFeature')
4. 推送 到分支 (git push origin feature/AmazingFeature)
5. 创建 Pull Request

• 遵循 JavaScript Standard Style
• 提交信息使用英文,格式: type(scope): description
• 新功能需要添加对应的文档
• 重要更改需要更新 CHANGELOG

使用 Issues 报告 Bug,请包含:

• 操作系统和版本
• MKReader 版本
• 复现步骤
• 期望行为
• 实际行为
• 截图(如适用)

本项目基于 MIT 许可证 开源。

感谢以下开源项目:

• Electron - 跨平台桌面应用框架
• markdown-it - Markdown 解析器
• Mermaid - 图表和图形生成库
• Prism - 代码语法高亮库
• GitHub Markdown CSS - GitHub 风格样式

• 项目主页: https://github.com/your-repo/mkreader
• 问题反馈: Issues
• 开发团队: MKReader Team