diff --git a/MDHelper_design.md b/MDHelper_design.md index 2a94a86..8749c93 100644 --- a/MDHelper_design.md +++ b/MDHelper_design.md @@ -1,20 +1,14 @@ # MDHelper 帮助文档阅读器设计方案 +当前版本:`0.2.0` + ## 1. 项目目标 -MDHelper 是一个用 Python 编写的本地帮助文档阅读器,文档主体由 Markdown 文件组成。项目默认读取根目录下的 `sample.md` 和 `docs/` 目录中的更多手册文件,并支持以下内容: +MDHelper 是一个用 Python 编写的本地文档阅读器。它以 Markdown 为核心,同时支持 HTML、Python、C/C++ 等本地文档或源码文件的可视化展示。项目重点是离线可用、对本地项目友好、支持多标签阅读、全文搜索、自动刷新、样式管理和导出。 -- 普通 Markdown 文本、标题、列表、引用、链接 -- Markdown 表格 -- 伪代码和代码块高亮 -- 图片显示:PNG、JPG、JPEG、WEBP、BMP、GIF -- 音频播放:MP3、WAV、OGG -- 动画/视频播放:GIF、MP4、WEBM、MOV 等浏览器可播放格式 -- 左侧文档目录、正文阅读区、搜索、历史导航 +0.2.0 阶段的核心目标是:在保持现有桌面应用能力的基础上,进一步提升阅读模式的滚动流畅度,让普通文档浏览更接近浏览器打开网页的体验。 -## 2. 推荐技术路线 - -推荐采用桌面应用架构: +## 2. 当前技术路线 ```text Python 3.13 @@ -22,187 +16,210 @@ Python 3.13 -> QWebEngineView 渲染 HTML -> markdown-it-py 解析 Markdown -> Pygments 生成代码高亮 HTML - -> 本地 CSS/JS 美化表格、代码块和媒体控件 + -> 本地 CSS/JS 管理表格、代码块、媒体控件、图片预览、滚动进度 ``` -选择 `QWebEngineView` 的主要原因是它内置 Chromium 渲染能力,可以自然展示 HTML5 `