Files
MDHelper/docs/quick_start.md
T
2026-06-22 18:07:34 +08:00

96 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# MDHelper 快速开始
## 1. 启动
源码运行:
```powershell
.\mdhelper_env\Scripts\python.exe -m mdhelper
```
打开指定文件夹:
```powershell
.\mdhelper_env\Scripts\python.exe -m mdhelper D:\CODE\SomeProject
```
打开指定 Markdown 文件:
```powershell
.\mdhelper_env\Scripts\python.exe -m mdhelper .\docs\user_manual.md
```
打包版同样支持路径参数:
```powershell
.\dist\MDHelper.exe D:\CODE\SomeProject
```
## 2. 打开文档
1. 点击左侧文档栏的打开按钮。
2. 选择一个文件夹或 Markdown 文件。
3. 左侧文件树会展示当前可阅读的文件。
4. 点击文件即可在标签页中打开。
如果选择单个 Markdown 文件,MDHelper 会自动把该文件所在目录作为当前文件夹。
## 3. 调整阅读体验
进入 `工具 - 设置`:
- `主题颜色`:彩色、白色、黑色、深灰色。
- `主题背景`:仅彩色主题下可选。
- `正文字号倍率`:调整阅读字号。
- `鼠标滚轮速度`:调整滚轮滚动倍率。
- `纸张宽度`:默认 A4,可选 `A4 × 1.25` 到 `A4 × 2`。
- `阅读导航`:网页内大纲、外部目录栏、网页内进度条。
- `展示文件类型`:Markdown / 网页、Python、C / C++、Fortran。
纸张宽度越大,同一行能显示的文字越多。
## 4. 搜索
左侧搜索框用于搜索当前文件夹:
1. 输入关键词。
2. 点击放大镜按钮搜索。
3. 用上/下箭头切换匹配结果。
当前页查找使用 `Ctrl+F`。
## 5. 编辑 Markdown
1. 打开一个 `.md` 或 `.markdown` 文件。
2. 按 `Ctrl+E` 进入编辑模式。
3. 在顶部选择源码、预览或分屏。
4. 按 `Ctrl+S` 保存。
编辑器支持查找替换、插入 Markdown 模板、草稿恢复和外部修改冲突检测。
## 6. 导出
打开 Markdown 后,可从菜单导出:
- PDF
- HTML
- DOCX
- MHTML
DOCX 可使用 pandoc 或 python-docx。MHTML 适合把 HTML 和资源打包成单个文件。
## 7. 文档检查
检查本地链接和媒体资源是否缺失:
```powershell
.\mdhelper_env\Scripts\python.exe -m mdhelper --check --project-root .
```
打包版:
```powershell
.\dist\MDHelper.exe --check --project-root .
```