# EasyMDReader

**Repository Path**: naeon/easy-mdreader

## Basic Information

- **Project Name**: EasyMDReader
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-25
- **Last Updated**: 2026-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EasyMDReader

[English](./README.md)

EasyMDReader 是一个基于 PyQt5 的轻量级桌面 Markdown 阅读与编辑工具。

## 功能特性

- 支持实时 Markdown 预览与代码高亮
- 提供编辑模式和阅读模式，可快速切换
- 阅读模式支持目录生成与章节跳转（侧边栏可折叠隐藏）
- 支持中英文界面切换
- 仿 Notion 风格 UI 设计，大圆角与温暖色调
- 代码块支持行号显示、语言标签识别、一键复制
- 支持 Markdown 表格渲染
- 支持从 Windows 资源管理器直接双击 .md 文件打开
- 新增文件菜单，包含打开、保存和关闭程序
- 标题栏显示程序名、文件名和当前模式

## 下载方式

- 请从仓库的 Release 页面下载最新版本
- 如果你希望解压后直接使用，请下载便携版压缩包
- 如果你希望标准安装到 Windows，请下载安装包

## 使用方法

- 便携版：下载 `EasyMDReader_v0.4.0_AMDx64_portable.zip`，解压后运行 `EasyMDReader_x64.exe`
- 安装版：下载 `EasyMDReader_v0.4.0_AMDx64_installer.exe`，运行安装程序并完成安装

## 运行环境

- Windows
- 建议使用 Python 3.13
- PyQt5
- markdown
- pygments

## 安装依赖

```powershell
python -m venv .venv
.\.venv\Scripts\pip install -r requirements.txt
```

## 本地运行

```powershell
python main.py
```

## 打包

如果你需要自行构建项目，可以使用仓库内已有的 PyInstaller 配置和 Inno Setup 安装脚本。

## 输出文件

- `dist/EasyMDReader_x64.exe`
- `dist/EasyMDReader_v0.4.0_AMDx64_portable.zip`
- `dist/EasyMDReader_v0.4.0_AMDx64_installer.exe`

## 项目结构

- `main.py`：程序入口
- `config/settings.py`：版本号与多语言文本
- `ui/`：界面组件（主窗口、编辑模式、阅读模式、菜单栏）
- `md_engine/`：Markdown 渲染引擎
- `file/`：文件操作
- `EasyMDReader_x64.spec`：64 位 PyInstaller 打包配置
- `EasyMDReader_x64_installer.iss`：安装包脚本
- `version_info.txt`：Windows 版本资源信息
- `changelog.md`：版本变更记录
- `LICENSE`：MIT 开源许可证

## 开源许可证

本项目采用 MIT License 开源。

## 当前版本

`v0.4.0`