# markdown-editor

**Repository Path**: kejigan0011/markdown-editor

## Basic Information

- **Project Name**: markdown-editor
- **Description**: No description available
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-03-23
- **Last Updated**: 2026-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown 编辑器

一款基于 Python + PyQt6 开发的桌面 Markdown 编辑器，界面简洁、功能实用，支持实时预览、多主题切换与文档导出。

> 制作公司：成都指尖云科技有限公司

![截图1](https://foruda.gitee.com/images/1774268475573382929/f9e91c24_9577531.png "屏幕截图")
![截图2](https://foruda.gitee.com/images/1774268489669266989/217efedf_9577531.png "屏幕截图")

---

## 功能特性

- **实时预览**：一键切换阅读模式，即时渲染 Markdown
- **语法高亮**：编辑器内 Markdown 语法着色（标题、加粗、斜体、代码、链接等）
- **多主题**：内置深色 / 浅色 / 护眼三套主题，设置自动持久化
- **文件树**：侧边栏目录树，快速浏览和打开文件夹内的 Markdown 文件
- **导出 PDF**：通过 QtWebEngine 渲染后导出高质量 PDF
- **导出 Word**：将 Markdown 转换为 `.docx` 格式
- **会话恢复**：自动记忆上次打开的文件夹
- **拖拽支持**：直接拖拽 `.md` 文件到窗口打开

---

## 快捷键

| 操作 | 快捷键 |
|------|--------|
| 新建 | `Ctrl+N` |
| 打开文件 | `Ctrl+O` |
| 打开文件夹 | `Ctrl+Shift+O` |
| 保存 | `Ctrl+S` |
| 另存为 | `Ctrl+Shift+S` |
| 显示/隐藏目录树 | `Ctrl+\` |

---

## 安装与运行

### 环境要求

- Python 3.10+
- Windows 10/11（推荐）

### 安装依赖

```bash
pip install -r requirements.txt
```

### 启动

```bash
python main.py
```

也可以传入文件或目录作为启动参数：

```bash
python main.py path/to/file.md
python main.py path/to/folder
```

---

## 依赖

| 包 | 用途 |
|----|------|
| PyQt6 | GUI 框架 |
| PyQt6-WebEngine | Markdown 预览渲染 |
| markdown-it-py | Markdown 解析 |
| pygments | 代码块语法高亮 |
| python-docx | 导出 Word 文档 |

---

## 项目结构

```
├── main.py           # 入口，启动画面
├── main_window.py    # 主窗口（菜单、工具栏、布局）
├── editor.py         # 编辑器组件（行号、语法高亮）
├── preview.py        # 预览组件（WebEngine）
├── highlighter.py    # Markdown 语法高亮器
├── exporter.py       # PDF / Word 导出
├── file_tree.py      # 文件目录树组件
├── themes.py         # 主题配置
├── requirements.txt  # 依赖列表
└── logo.png          # 应用图标
```

---

## 打包发布

项目内置打包脚本，使用 PyInstaller 生成独立可执行文件：

```bash
build.bat
```

---

## License

MIT