commit 50b15b02c7ae52c44ea1df906dd0b2ceded4cb90 Author: shenw Date: Mon May 25 17:12:00 2026 +0800 Initial MDHelper implementation diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..43b8243 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +__pycache__/ +*.py[cod] +*$py.class + +mdhelper_env/ +.venv/ +venv/ +env/ + +.pytest_cache/ +.mypy_cache/ +.ruff_cache/ + +logs/ +*.log + +build/ +dist/ +*.spec + +html/ + +.DS_Store +Thumbs.db diff --git a/MDHelper_design.md b/MDHelper_design.md new file mode 100644 index 0000000..2a94a86 --- /dev/null +++ b/MDHelper_design.md @@ -0,0 +1,208 @@ +# MDHelper 帮助文档阅读器设计方案 + +## 1. 项目目标 + +MDHelper 是一个用 Python 编写的本地帮助文档阅读器,文档主体由 Markdown 文件组成。项目默认读取根目录下的 `sample.md` 和 `docs/` 目录中的更多手册文件,并支持以下内容: + +- 普通 Markdown 文本、标题、列表、引用、链接 +- Markdown 表格 +- 伪代码和代码块高亮 +- 图片显示:PNG、JPG、JPEG、WEBP、BMP、GIF +- 音频播放:MP3、WAV、OGG +- 动画/视频播放:GIF、MP4、WEBM、MOV 等浏览器可播放格式 +- 左侧文档目录、正文阅读区、搜索、历史导航 + +## 2. 推荐技术路线 + +推荐采用桌面应用架构: + +```text +Python 3.13 + -> PySide6 / Qt Widgets + -> QWebEngineView 渲染 HTML + -> markdown-it-py 解析 Markdown + -> Pygments 生成代码高亮 HTML + -> 本地 CSS/JS 美化表格、代码块和媒体控件 +``` + +选择 `QWebEngineView` 的主要原因是它内置 Chromium 渲染能力,可以自然展示 HTML5 `