From 2f480e7c8f94b73844c1aa3c741831706c89e13e Mon Sep 17 00:00:00 2001 From: shenw Date: Thu, 18 Jun 2026 12:30:37 +0800 Subject: [PATCH] Update 0.2.0 reader UX and MDHelper docs --- MDHelper_design.md | 303 +++--- README.md | 153 ++- docs/README.md | 1900 +-------------------------------- docs/coding_conventions.md | 8 - docs/configuration.md | 314 ------ docs/examples_manual.md | 112 -- docs/fem_manual.md | 1213 --------------------- docs/geometry_manual.md | 356 ------ docs/glossary.md | 35 - docs/installation.md | 127 --- docs/io_manual.md | 305 ------ docs/material_manual.md | 485 --------- docs/meshing_manual.md | 603 ----------- docs/pipeline.md | 135 --- docs/project_structure.md | 66 -- docs/quick_start.md | 140 +-- docs/sph_manual.md | 1693 ----------------------------- docs/troubleshooting.md | 223 ++-- docs/user_manual.md | 366 ++++--- mdhelper/__init__.py | 2 +- mdhelper/main_window.py | 148 ++- mdhelper/markdown_editor.py | 27 +- mdhelper/markdown_renderer.py | 128 ++- mdhelper/resources/reader.css | 206 +++- mdhelper/resources/reader.js | 208 +++- mdhelper/settings_dialog.py | 47 + tests/gui_smoke.py | 76 +- tests/test_renderer.py | 34 +- todo.md | 40 +- 29 files changed, 1499 insertions(+), 7954 deletions(-) delete mode 100644 docs/coding_conventions.md delete mode 100644 docs/configuration.md delete mode 100644 docs/examples_manual.md delete mode 100644 docs/fem_manual.md delete mode 100644 docs/geometry_manual.md delete mode 100644 docs/glossary.md delete mode 100644 docs/installation.md delete mode 100644 docs/io_manual.md delete mode 100644 docs/material_manual.md delete mode 100644 docs/meshing_manual.md delete mode 100644 docs/pipeline.md delete mode 100644 docs/project_structure.md delete mode 100644 docs/sph_manual.md 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 `