Markdown Reader

一款简单、轻量级的 Windows 桌面应用程序，用于阅读和编辑 Markdown 文件。

Markdown Reader 在 Markdown 源码旁提供实时渲染预览，支持拖放文件，并可将完成的文档直接导出为 PDF。它基于 Python 和 PySide6 构建，无需 Web 浏览器或服务器。 ## 功能 - 支持拖放 `.md`、`.markdown`、`.mdown` 和 `.mkd` 文件 - 编辑时提供实时的 GitHub 风格 Markdown 预览 - 支持分屏视图、纯预览视图和纯编辑视图 - 包含新建、打开、关闭、保存和另存为命令 - 支持将渲染后的文档导出为 PDF - 支持放大、缩小和重置缩放 - 支持文本查找并在匹配项之间跳转 - 支持撤销、重做、剪切、复制、粘贴和全选 - 包含最近打开的文件菜单 - 具备未保存更改保护功能 - 本地图片和链接基于 Markdown 文件的相对路径进行解析 - 采用用户熟悉的 Windows 键盘快捷键 ## Windows 下载 最简单的安装方式是打开[最新的 GitHub Release](https://github.com/BrennanNVA/MarkdownReader/releases/latest)，下载 `MarkdownReader-v0.1.1-windows-x64.zip`，解压整个文件夹，然后运行 **`Markdown Reader.exe`**。 此便携版不需要 Python、`uv` 或任何安装程序。 ## 从源码运行的前置条件 - Windows 10 或 Windows 11 - Python 3.11 或更高版本 - [`uv`](https://docs.astral.sh/uv/getting-started/installation/) ## 从源码运行 1. 下载或克隆此代码仓库： git clone https://github.com/BrennanNVA/MarkdownReader.git cd MarkdownReader 2. 双击 **`run_markdown_reader.bat`**。 首次运行时，启动器会创建一个独立的虚拟环境并安装必要的依赖包。随后的启动将直接复用该环境。 你也可以在终端中启动它： ``` uv sync --extra dev uv run markdown-reader ``` 若要直接打开文件： ``` uv run markdown-reader path/to/document.md ``` 项目附带了一个示例文档 `sample.md`。 ## 键盘快捷键 | 快捷键 | 操作 | |---|---| | `Ctrl+N` | 新建文档 | | `Ctrl+O` | 打开文件 | | `Ctrl+S` | 保存 | | `Ctrl+Shift+S` | 另存为 | | `Ctrl+W` | 关闭文件 | | `Ctrl+P` | 导出为 PDF | | `Ctrl+F` | 查找 | | `Ctrl++` / `Ctrl+-` | 放大/缩小 | | `Ctrl+0` | 重置缩放 | | `Ctrl+1` | 分屏视图 | | `Ctrl+2` | 纯预览 | | `Ctrl+3` | 纯编辑 | ## 构建独立的 Windows 应用程序 双击 **`build_exe.bat`**，或者运行： ``` uv sync --extra dev uv run pyinstaller --noconfirm --clean --windowed --name "Markdown Reader" --paths src --icon src/markdown_reader/assets/icon.ico --add-data "src/markdown_reader/assets/icon.png;markdown_reader/assets" src/markdown_reader/app.py ``` 便携版应用程序将生成于： ``` dist/Markdown Reader/Markdown Reader.exe ``` 将应用程序移动到其他 Windows 计算机时，请复制整个 `dist/Markdown Reader` 目录。 ## 开发与测试 安装开发依赖并运行测试套件： ``` uv sync --extra dev uv run pytest ``` 测试涵盖了拖放路由、Markdown 加载与渲染、UTF-8 编辑与保存、另存为、视图与缩放控制，以及实际的 PDF 生成。 ## 技术 - Python 3.11+ - PySide6 / Qt 6 - pytest 和 pytest-qt - 使用 PyInstaller 进行可选的 Windows 打包 ## 许可证 Markdown Reader 基于 [MIT 许可证](LICENSE) 发布。

标签：Markdown 编辑器, PDF 导出, PySide6, Windows 桌面应用, 安全规则引擎, 文本编辑器, 文档处理, 漏洞挖掘, 逆向工具