2026-06-18 12:30:37 +08:00
|
|
|
# MDHelper 帮助文档
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
本目录保存 MDHelper 的用户帮助文档。
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
## 推荐阅读顺序
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
1. [快速开始](quick_start.md)
|
|
|
|
|
2. [用户手册](user_manual.md)
|
|
|
|
|
3. [常见问题](troubleshooting.md)
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
## 常用主题
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
| 主题 | 文档 |
|
|
|
|
|
|---|---|
|
|
|
|
|
| 启动、打开文件夹、路径参数 | [快速开始](quick_start.md) |
|
2026-09-17 14:56:48 +08:00
|
|
|
| 阅读界面、左侧大纲、纸张宽度 | [用户手册](user_manual.md) |
|
2026-06-18 12:30:37 +08:00
|
|
|
| Markdown 编辑、分屏预览、草稿 | [用户手册](user_manual.md) |
|
|
|
|
|
| 文件类型展示、代码文件阅读 | [用户手册](user_manual.md) |
|
|
|
|
|
| PDF/HTML/DOCX/MHTML 导出 | [用户手册](user_manual.md) |
|
|
|
|
|
| 卡顿、目录位置、导出失败、打包问题 | [常见问题](troubleshooting.md) |
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
## 命令行检查
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
```powershell
|
|
|
|
|
.\mdhelper_env\Scripts\python.exe -m mdhelper --check --project-root .
|
2026-05-25 17:12:00 +08:00
|
|
|
```
|
|
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
打包版:
|
2026-05-25 17:12:00 +08:00
|
|
|
|
2026-06-18 12:30:37 +08:00
|
|
|
```powershell
|
2026-09-17 14:56:48 +08:00
|
|
|
.\dist\MDHelper\MDHelper.exe --check --project-root .
|
2026-05-25 17:12:00 +08:00
|
|
|
```
|