2.4 KiB
2.4 KiB
MDHelper 快速开始
1. 启动
源码运行:
.\mdhelper_env\Scripts\python.exe -m mdhelper
打开指定文件夹:
.\mdhelper_env\Scripts\python.exe -m mdhelper D:\CODE\SomeProject
打开指定 Markdown 文件:
.\mdhelper_env\Scripts\python.exe -m mdhelper .\docs\user_manual.md
打包版同样支持路径参数:
.\dist\MDHelper\MDHelper.exe D:\CODE\SomeProject
2. 打开文档
- 点击左侧文档栏的打开按钮。
- 选择一个文件夹或 Markdown 文件。
- 左侧文件树会展示当前可阅读的文件。
- 点击文件即可在标签页中打开。
如果选择单个 Markdown 文件,MDHelper 会自动把该文件所在目录作为当前文件夹。
3. 调整阅读体验
进入 工具 - 设置:
主题颜色:彩色、白色、黑色、深灰色。主题背景:仅彩色主题下可选。正文字号倍率:调整阅读字号。鼠标滚轮速度:调整滚轮滚动倍率。纸张宽度:默认 A4,可选A4 × 1.25到A4 × 2。展示文件类型:Markdown / 网页、Python、C / C++、Fortran。
纸张宽度越大,同一行能显示的文字越多。
左侧导航栏可在 目录 和 大纲 间切换。大纲只在点击标题时跳转,不跟随正文滚动。
4. 搜索
左侧搜索框用于搜索当前文件夹:
- 输入关键词。
- 点击放大镜按钮搜索。
- 用上/下箭头切换匹配结果。
当前页查找使用 Ctrl+F。
5. 编辑 Markdown
- 打开一个
.md或.markdown文件。 - 按
Ctrl+E进入编辑模式。 - 在顶部选择源码、预览或分屏。
- 按
Ctrl+S保存。
编辑器支持查找替换、插入 Markdown 模板、草稿恢复和外部修改冲突检测。
6. 导出
打开 Markdown 后,可从菜单导出:
- HTML
- DOCX
- MHTML
导出 PDF 时可设置四边页边距。PDF 会使用白色页面,并在正文前自动生成带页码的目录页。
DOCX 可使用 Pandoc 或 python-docx;正式安装版已包含 Pandoc,无需额外安装。MHTML 适合把 HTML 和资源打包成单个文件。
7. 文档检查
检查本地链接和媒体资源是否缺失:
.\mdhelper_env\Scripts\python.exe -m mdhelper --check --project-root .
打包版:
.\dist\MDHelper\MDHelper.exe --check --project-root .