2026-05-25 19:21:24 +08:00
2026-05-25 17:12:00 +08:00
2026-05-25 19:21:24 +08:00
2026-05-25 17:12:00 +08:00
2026-05-25 17:12:00 +08:00
2026-05-25 17:12:00 +08:00
2026-05-25 17:12:00 +08:00
2026-05-25 17:12:00 +08:00

MDHelper

MDHelper 是一个用 Python 和 Markdown 文件组成的本地帮助文档阅读器。

功能

  • 浏览根目录 sample.md 和 docs/ 下的 Markdown 文档
  • 显示文字、表格、引用、列表和链接
  • 使用 Pygments 高亮代码块和伪代码
  • 支持任务列表和 [!TIP]、[!WARNING] 等提示块
  • 显示图片和 GIF 动画
  • 内嵌播放音频和视频
  • 支持 Markdown 文档间跳转、外部链接打开、字号调整、浅色/深色主题
  • 支持多标签页阅读
  • 单击本地 .md 和网页文件链接会在 MDHelper 标签页内展示
  • 单击其他本地文件链接时,会先询问是否用本地默认软件打开
  • 右键本地文件链接可选择“在本标签页打开”或“新建标签页打开”
  • 右侧显示当前文档标题目录
  • 滚动阅读时自动高亮当前章节目录
  • 状态栏显示当前文档阅读进度
  • 搜索框支持标题、文件名和正文全文搜索
  • 全文搜索使用内存索引缓存,避免输入时反复读取磁盘
  • 搜索时显示匹配文档结果列表,并保留文档树过滤
  • 点击搜索结果后自动在当前页查找并高亮命中词
  • 支持当前页查找
  • 自动刷新当前文档和已引用的本地媒体文件
  • 鼠标悬停链接时在状态栏显示目标地址
  • 表格支持横向滚动和一键复制
  • 图片点击放大,支持缩放、旋转、重置,按 Esc 或点击遮罩关闭
  • 代码块提供一键复制按钮
  • 代码块支持行号,长代码块可折叠/展开
  • 支持添加、打开、重命名和删除书签
  • 自动恢复上次阅读位置
  • 可将当前文档导出为 PDF
  • 可将当前文档导出为 HTML
  • 自动保存窗口状态、字号、主题和最近文件
  • 提供设置窗口,可配置主题、字号、自动刷新和其他本地文件处理策略
  • 提供文档检查命令,可扫描缺失的本地链接和媒体资源
  • 运行日志保存到 logs/mdhelper.log
  • 可打开任意本地 Markdown 文件

快捷键

快捷键 功能
Ctrl+O 打开 Markdown 文件
Ctrl+P 导出当前文档为 PDF
Ctrl+D 添加当前文档/章节为书签
Ctrl+F 查找当前页
Ctrl+Shift+F 全文搜索
F5 刷新当前文档

运行

在项目根目录执行:

.\mdhelper_env\Scripts\python.exe -m mdhelper

启动时直接打开指定文件:

.\mdhelper_env\Scripts\python.exe -m mdhelper .\docs\user_manual.md

也可以执行:

.\mdhelper_env\Scripts\python.exe .\run_mdhelper.py

检查文档中的本地链接和媒体文件:

.\mdhelper_env\Scripts\python.exe -m mdhelper --check

依赖

核心依赖已写入 requirements.txt:

PySide6
markdown-it-py
Pygments
Pillow
S
Description
No description provided
Readme 271 MiB
Languages
Python 92%
PowerShell 4.2%
JavaScript 1.7%
CSS 1.5%
Lua 0.5%
Other 0.1%