# markdown-reader

**Repository Path**: running_tortoise/markdown-reader

## Basic Information

- **Project Name**: markdown-reader
- **Description**: # 📖 Markdown Reader

一个简洁美观的 Markdown 文件阅读桌面工具
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-31
- **Last Updated**: 2025-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 📖 Markdown Reader

一个简洁美观的 Markdown 文件阅读桌面工具

## ✨ 功能特性

- 🎨 **现代化界面** - 简洁美观的用户界面设计
- 📝 **完整 Markdown 支持** - 支持 CommonMark 规范的所有语法
- 🌙 **主题切换** - 明暗两种主题，保护眼睛
- 🎯 **代码高亮** - 内置语法高亮，支持多种编程语言
- 📋 **代码复制** - 一键复制代码块内容
- 📚 **最近文件** - 记录最近打开的文件，快速访问
- 🖨️ **打印支持** - 优化的打印样式
- ⌨️ **快捷键支持** - 提高操作效率

## 🚀 快速开始

### 安装依赖

```bash
npm install
```

### 运行应用

```bash
npm start
```

### 构建应用

```bash
npm run build
```

## 📋 快捷键

| 功能 | Windows/Linux | macOS |
|------|---------------|-------|
| 打开文件 | `Ctrl + O` | `Cmd + O` |
| 打开文件夹 | `Ctrl + Shift + O` | `Cmd + Shift + O` |
| 切换主题 | `Ctrl + T` | `Cmd + T` |
| 刷新内容 | `Ctrl + R` | `Cmd + R` |
| 关闭文件 | `Ctrl + W` 或 `ESC` | `Cmd + W` 或 `ESC` |
| 退出应用 | `Ctrl + Q` | `Cmd + Q` |

## 🎯 支持的文件格式

- `.md` - Markdown 文件
- `.markdown` - Markdown 文件
- `.mdown` - Markdown 文件  
- `.mkd` - Markdown 文件

## 📸 界面预览

### 明亮主题
现代化的明亮主题界面，适合日间使用

### 暗色主题  
护眼的暗色主题界面，适合夜间使用

## 🛠️ 技术栈

- **Electron** - 跨平台桌面应用框架
- **marked** - Markdown 解析器
- **highlight.js** - 代码语法高亮
- **GitHub Markdown CSS** - 标准的 Markdown 样式

## 📦 项目结构

```
markdown-reader/
├── main.js           # Electron 主进程
├── renderer.js       # 渲染进程逻辑
├── index.html        # 主界面
├── style.css         # 样式文件
├── package.json      # 项目配置
└── README.md         # 项目说明
```

## 🔧 开发说明

### 开发模式运行

```bash
npm run dev
```

### 构建可执行文件

构建后的文件将在 `dist` 目录中：

```bash
npm run build
```

## 📄 许可证

MIT License

## 🤝 贡献

欢迎提交 Issue 和 Pull Request！

## 📞 支持

如果你遇到任何问题或有改进建议，请：

1. 查看 [Issues](../../issues) 页面
2. 提交新的 Issue
3. 或者直接提交 Pull Request

---

**享受愉快的 Markdown 阅读体验！** ✨