feat: optimize startup and add Windows installer
This commit is contained in:
+2
-2
@@ -13,7 +13,7 @@
|
||||
| 主题 | 文档 |
|
||||
|---|---|
|
||||
| 启动、打开文件夹、路径参数 | [快速开始](quick_start.md) |
|
||||
| 阅读界面、网页内大纲、纸张宽度 | [用户手册](user_manual.md) |
|
||||
| 阅读界面、左侧大纲、纸张宽度 | [用户手册](user_manual.md) |
|
||||
| Markdown 编辑、分屏预览、草稿 | [用户手册](user_manual.md) |
|
||||
| 文件类型展示、代码文件阅读 | [用户手册](user_manual.md) |
|
||||
| PDF/HTML/DOCX/MHTML 导出 | [用户手册](user_manual.md) |
|
||||
@@ -28,5 +28,5 @@
|
||||
打包版:
|
||||
|
||||
```powershell
|
||||
.\dist\MDHelper.exe --check --project-root .
|
||||
.\dist\MDHelper\MDHelper.exe --check --project-root .
|
||||
```
|
||||
|
||||
+7
-4
@@ -23,7 +23,7 @@
|
||||
打包版同样支持路径参数:
|
||||
|
||||
```powershell
|
||||
.\dist\MDHelper.exe D:\CODE\SomeProject
|
||||
.\dist\MDHelper\MDHelper.exe D:\CODE\SomeProject
|
||||
```
|
||||
|
||||
## 2. 打开文档
|
||||
@@ -44,11 +44,12 @@
|
||||
- `正文字号倍率`:调整阅读字号。
|
||||
- `鼠标滚轮速度`:调整滚轮滚动倍率。
|
||||
- `纸张宽度`:默认 A4,可选 `A4 × 1.25` 到 `A4 × 2`。
|
||||
- `阅读导航`:网页内大纲、外部目录栏、网页内进度条。
|
||||
- `展示文件类型`:Markdown / 网页、Python、C / C++、Fortran。
|
||||
|
||||
纸张宽度越大,同一行能显示的文字越多。
|
||||
|
||||
左侧导航栏可在 `目录` 和 `大纲` 间切换。大纲只在点击标题时跳转,不跟随正文滚动。
|
||||
|
||||
## 4. 搜索
|
||||
|
||||
左侧搜索框用于搜索当前文件夹:
|
||||
@@ -77,7 +78,9 @@
|
||||
- DOCX
|
||||
- MHTML
|
||||
|
||||
DOCX 可使用 pandoc 或 python-docx。MHTML 适合把 HTML 和资源打包成单个文件。
|
||||
导出 PDF 时可设置四边页边距。PDF 会使用白色页面,并在正文前自动生成带页码的目录页。
|
||||
|
||||
DOCX 可使用 Pandoc 或 python-docx;正式安装版已包含 Pandoc,无需额外安装。MHTML 适合把 HTML 和资源打包成单个文件。
|
||||
|
||||
## 7. 文档检查
|
||||
|
||||
@@ -90,6 +93,6 @@ DOCX 可使用 pandoc 或 python-docx。MHTML 适合把 HTML 和资源打包成
|
||||
打包版:
|
||||
|
||||
```powershell
|
||||
.\dist\MDHelper.exe --check --project-root .
|
||||
.\dist\MDHelper\MDHelper.exe --check --project-root .
|
||||
```
|
||||
|
||||
|
||||
+9
-17
@@ -1,19 +1,14 @@
|
||||
# MDHelper 常见问题
|
||||
|
||||
## 右侧外部目录栏还显示
|
||||
## 找不到文档大纲
|
||||
|
||||
默认推荐使用网页内文档大纲,位置在正文右侧。若仍看到最右侧 Qt 目录栏,请检查:
|
||||
大纲已经移到左侧导航栏:
|
||||
|
||||
1. 打开 `工具 - 设置`。
|
||||
2. 勾选 `网页内大纲`。
|
||||
3. 取消或禁用 `外部目录栏`。
|
||||
4. 刷新当前文档。
|
||||
1. 点击左侧的 `大纲` 页签。
|
||||
2. 点击标题即可跳转。
|
||||
3. 如果列表为空,请确认当前文档包含 Markdown 标题,必要时刷新当前文档。
|
||||
|
||||
当网页内大纲开启时,外部目录栏会自动隐藏。
|
||||
|
||||
## 文档大纲在正文左侧
|
||||
|
||||
0.2.0 当前布局应为正文在左、大纲在正文右侧。如果仍在左侧,说明正在运行旧 exe 或旧源码。请重新运行最新源码,或重新打包 exe。
|
||||
大纲不会跟随正文滚动选中当前章节,这是为了避免持续定位和界面同步。
|
||||
|
||||
## 每行文字太少或太多
|
||||
|
||||
@@ -29,8 +24,6 @@
|
||||
|
||||
可尝试:
|
||||
|
||||
- 使用网页内大纲和网页内进度条。
|
||||
- 关闭外部目录栏。
|
||||
- 将鼠标滚轮速度保持在 `1.0` 附近。
|
||||
- 对超大代码文件,避免同时启用过多文件类型。
|
||||
- Mermaid、公式、大图片和超长代码块很多的文档会更依赖 WebEngine 渲染性能。
|
||||
@@ -71,12 +64,11 @@ MDHelper 读取文档时不会锁定文件,外部编辑器仍可保存。
|
||||
|
||||
检查:
|
||||
|
||||
- 是否安装 pandoc。
|
||||
- 是否安装 python-docx。
|
||||
- 当前文档路径和输出目录是否可写。
|
||||
- 文档中引用的图片路径是否存在。
|
||||
|
||||
如果 pandoc 不可用,可切换到 python-docx 相关实现;复杂 Markdown 的 DOCX 版式通常 pandoc 更稳定。
|
||||
正式安装版 MDHelper 已包含 Pandoc,无需用户安装或配置 PATH。如果提示“未找到程序内置的 Pandoc”,说明程序文件可能不完整,请重新获取完整版本。也可临时切换到 python-docx 或内置基础导出;复杂 Markdown 的 DOCX 版式通常 Pandoc 更稳定。
|
||||
|
||||
## PDF 导出失败
|
||||
|
||||
@@ -112,13 +104,13 @@ MDHelper 读取文档时不会锁定文件,外部编辑器仍可保存。
|
||||
说明 PyInstaller 打包时没有正确带上 PySide6 或 WebEngine 资源。请使用项目根目录下的 `MDHelper.spec` 打包:
|
||||
|
||||
```powershell
|
||||
.\mdhelper_env\Scripts\python.exe -m PyInstaller .\MDHelper.spec --noconfirm --clean
|
||||
.\pack\_installer.cmd
|
||||
```
|
||||
|
||||
打包后执行:
|
||||
|
||||
```powershell
|
||||
.\dist\MDHelper.exe --check --project-root .
|
||||
.\dist\MDHelper\MDHelper.exe --check --project-root .
|
||||
```
|
||||
|
||||
## 如何定位日志
|
||||
|
||||
+13
-11
@@ -31,22 +31,21 @@ MDHelper 是一个本地 Markdown / 代码文档阅读器,适合阅读项目
|
||||
打包版可以同样接收路径参数:
|
||||
|
||||
```powershell
|
||||
.\dist\MDHelper.exe D:\CODE\SomeProject
|
||||
.\dist\MDHelper\MDHelper.exe D:\CODE\SomeProject
|
||||
```
|
||||
|
||||
MDHelper 支持同时运行多个程序窗口。不同窗口可以打开不同文件夹,标签页、搜索、设置和自动刷新状态互不影响。
|
||||
|
||||
## 3. 主界面
|
||||
|
||||
界面主要分为三部分:
|
||||
界面主要分为两部分:
|
||||
|
||||
| 区域 | 功能 |
|
||||
|---|---|
|
||||
| 左侧文档栏 | 打开文件夹、刷新、搜索、文件树、文件类型过滤结果。 |
|
||||
| 左侧导航栏 | 在“目录”和“大纲”间切换;目录包含搜索与文件树,大纲显示当前文档标题。 |
|
||||
| 中间标签页 | 阅读、编辑、预览、媒体页面和欢迎页。 |
|
||||
| 文档内容右侧 | 网页内文档大纲,随正文滚动高亮当前章节。 |
|
||||
|
||||
默认阅读模式会把文档大纲和阅读进度放在网页内部,减少 Qt 控件同步,让滚动更接近浏览器网页。右侧旧 Qt 目录栏默认关闭;只有在设置中关闭网页内大纲并启用外部目录栏时才显示。
|
||||
阅读页只显示正文,不在网页内部生成大纲或进度条。左侧大纲不会随正文滚动高亮;只有用户点击标题时才执行跳转,避免长文档滚动时持续计算当前位置。
|
||||
|
||||
## 4. 阅读 Markdown
|
||||
|
||||
@@ -60,9 +59,7 @@ Markdown 支持:
|
||||
- 本地图片、GIF、音频和视频。
|
||||
- 本地链接跳转和外部链接打开。
|
||||
|
||||
阅读页内的文档大纲位于正文右侧,点击章节可跳转。窄窗口下大纲会自动折叠或隐藏。
|
||||
|
||||
右下角阅读进度条会跟随主题改变颜色。进度条只在网页内部更新,Python 端只低频保存滚动位置。
|
||||
切换左侧的 `大纲` 页签并点击章节即可跳转。滚动位置仍会低频保存,用于重新打开文档时恢复阅读位置。
|
||||
|
||||
## 5. 纸张宽度与每行字数
|
||||
|
||||
@@ -115,12 +112,15 @@ Markdown 支持:
|
||||
- 行号和当前行高亮。
|
||||
- 查找、替换、区分大小写、全词匹配。
|
||||
- 插入标题、加粗、斜体、代码块、表格、链接、图片、提示块、Mermaid、公式。
|
||||
- 点击“转换latex公式到md”,可将全文中的 `\\[` 和 `\\]` 一键转换为 `$$`,并支持回退撤销。
|
||||
- 打开文件夹后,可通过“文件 → 新建文件”或左侧目录树右键菜单直接创建 `.md` 文件。新文件会在目标目录中自动生成并进入文件名编辑状态,无需打开浏览窗口。
|
||||
- 左侧目录树支持多选文件;右键单个文件可重命名,右键选择“删除”并确认后可批量移入系统回收站。右键非根文件夹还可在确认后删除该文件夹及其内容。
|
||||
- `Ctrl+S` 保存。
|
||||
- 另存为。
|
||||
- 自动保存草稿和恢复草稿。
|
||||
- 保存前检测磁盘文件是否被外部程序修改,避免覆盖外部编辑。
|
||||
|
||||
编辑预览中的网页内大纲可点击定位源码标题。预览刷新使用防抖机制,避免每次按键都重新渲染。
|
||||
编辑时左侧大纲可点击定位源码标题。预览刷新使用防抖机制,避免每次按键都重新渲染。
|
||||
|
||||
## 9. 样式管理
|
||||
|
||||
@@ -186,7 +186,9 @@ MDHelper 读取文档时不会独占文件,外部程序仍可修改文件。
|
||||
- DOCX
|
||||
- MHTML
|
||||
|
||||
DOCX 导出可选择 `pandoc` 或 `python-docx` 相关实现。导出的 HTML 默认不包含网页内阅读进度条,避免把阅读状态写进文档。
|
||||
PDF 导出前会显示设置窗口,可分别设置上、下、左、右页边距。导出文件固定使用白色纸张背景,自动移除阅读页大纲和进度条,并在正文前生成带真实页码的目录;正文从目录后的新页面开始。
|
||||
|
||||
DOCX 导出可选择 `pandoc` 或 `python-docx` 相关实现。正式安装版已包含 Pandoc,无需用户另行下载或配置 PATH。导出的 HTML 与阅读页一样不包含阅读进度控件。
|
||||
|
||||
## 13. 配置与迁移
|
||||
|
||||
@@ -226,6 +228,6 @@ MDHelper 会保存:
|
||||
打包版:
|
||||
|
||||
```powershell
|
||||
.\dist\MDHelper.exe --check --project-root .
|
||||
.\dist\MDHelper\MDHelper.exe --check --project-root .
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user