8.0 KiB
8.0 KiB
MDHelper TODO
1. Markdown 编辑功能
- 增加基础编辑模式:打开当前
.md/.markdown源文件,使用QPlainTextEdit编辑。 - 支持快捷键:
Ctrl+E进入编辑,Ctrl+S保存。 - 保存后刷新当前阅读页、右侧目录、左侧文档树和全文搜索索引。
- 避免保存触发
QFileSystemWatcher后重复刷新或状态抖动。
风险与注意事项:
- 内置保存和外部编辑器保存都会触发文件监听,需要区分“程序自己保存”和“外部变更”。
- 当前多标签页可以打开同一个文件,保存后要明确哪些标签页刷新。
- 编辑时关闭窗口或切换文件要防止未保存内容丢失。
- 非 UTF-8 编码文件可能读取失败,需要给出友好的错误提示。
2. 分屏编辑与预览
- 增加“源码 / 预览 / 分屏”视图模式。
- 编辑时使用防抖刷新预览,避免每次按键都完整渲染。
- 分屏模式下保持预览滚动位置尽量稳定。
风险与注意事项:
- WebEngine 渲染较重,实时预览需要节流。
- 标题 slug、Mermaid、公式和媒体资源都依赖完整渲染,局部刷新不一定可靠。
- 分屏会改变主界面布局,需要和现有多标签、主题、目录栏协同。
3. 编辑体验增强
- 增加 Markdown 语法高亮。
- 增加行号、当前行高亮、查找/替换。
- 增加未保存标记,并在关闭标签页/窗口时询问保存。
- 支持自动保存或恢复草稿。
风险与注意事项:
- 自动保存可能覆盖用户不想保存的临时改动,默认应谨慎。
- 查找/替换要区分“源码编辑器内查找”和“阅读页页内查找”。
- 行号和大文件语法高亮可能影响性能。
4. 文件打开与链接策略继续完善
- 本地非预览文件支持记住用户选择的打开程序,例如
.mp4 -> VLC.exe。 - 同类文件下次自动使用记住的程序打开。
- 提供管理已记住程序的入口。
风险与注意事项:
- 记住的程序路径可能被移动或卸载,打开前需要校验。
- 不应强行在标签页内展示所有媒体,系统默认程序或用户指定程序更稳。
5. GUI 自动化测试
- 覆盖本地链接在本标签页/新标签页打开的路由。
- 补充右键菜单动作信号测试。
- 覆盖本地文件打开策略的程序记忆、HTML 导出辅助路径。
- 补充真实 PDF 导出和外部程序选择动作测试。
- 覆盖书签恢复、滚动位置恢复、主题切换、编辑保存刷新。
风险与注意事项:
- Qt WebEngine 在无界面环境下偶发不稳定,测试要保留最小烟雾测试和可重复的等待条件。
- 涉及系统默认程序的测试应避免真的启动外部播放器。
6. 发布与打包
- 功能稳定后再重新执行 PyInstaller 打包。
- 打包前确认 WebEngine、资源文件、媒体示例和日志路径正常。
- 打包后运行
dist/MDHelper.exe --check或等价检查。
风险与注意事项:
- WebEngine 资源和离线 Mermaid/KaTeX/MathJax 文件容易漏打包。
- 单文件 exe 首次启动会解压,启动日志路径要能写入。
7. Markdown 编辑器继续完善
- 将编辑器类拆分到独立模块,降低主窗口复杂度。
- 将 Markdown 编辑器嵌入标签栏,默认以分屏模式打开。
- 点选“编辑当前 Markdown”时用编辑标签原位替换原阅读标签。
- 编辑器顶部不再单独显示文档路径,路径由标签标题表达。
- 编辑器控制栏合并“视图、查找源码、替换、大小写、全词”等控件。
- 保存前检测磁盘文件是否被外部修改,避免覆盖外部编辑。
- 增加“另存为”功能,并刷新文档树和搜索索引。
- 草稿记录补充保存时间、文件修改时间、文件大小等信息。
- 查找/替换增加命中数量、当前位置、区分大小写、全词匹配和
Ctrl+H。 - 分屏模式增加源码和预览的滚动同步。
- 增加插入工具栏:标题、加粗、斜体、代码块、表格、链接、图片、提示块、Mermaid、公式。
- 编辑器颜色跟随应用主题,深色主题下保持可读。
- 补充编辑器专项测试:外部修改冲突、另存为、查找替换、草稿元数据、插入模板。
- 补充编辑器标签页测试:默认分屏、标签内保存、保存后不关闭。
8. 目录跳转稳定性
- 点击目录标题时仅在阅读标签页执行跳转,避免编辑标签页误用旧阅读页。
- 锚点跳转改为多次重试,兼容 WebEngine 页面尚未完全就绪的情况。
- 跳转时更新页面 hash 并触发滚动状态上报,提升目录高亮一致性。
- 编辑标签页中目录栏展示当前源码标题,并支持点击定位到源码标题。
9. 启动与项目目录
- 默认启动不再自动打开内置示例文件夹和
sample.md。 - 首次无记录时提示用户选择文件夹或文件。
- 选择 Markdown 文件时自动把文件所在目录作为当前文件夹。
- 记录上次打开的文件夹,下次启动自动恢复该文件夹。
- 记录窗口大小和位置,下次启动按上次窗口几何恢复,不再启动后强制固定大小。
10. 欢迎页与文件树
- 标签栏没有文档时自动显示只读欢迎标签。
- 打开任意文档时自动关闭欢迎标签。
- 所有文档标签关闭后自动恢复欢迎标签。
- 打开文件夹后左侧文档栏按目录结构展示当前文件夹下的文件。
- 从“打开文件”选择文件时,自动把文件所在目录作为当前文件夹,并打开该文件内容。
- 左侧文件树点击 Markdown/网页文件在标签页打开,其他文件沿用本地程序打开策略。
- 默认仅展开当前文件夹根节点,子文件夹保持折叠,减少大目录下的视觉噪音。
- 为文件夹和文件设置相近但不同的文字颜色,文件按类型显示图标,接近 VSCode 的文件树识别体验。
- 文件树仅展示 Markdown 和网页文档,文件夹优先并按名称排序。
- 文件树右键支持切换 Markdown 显示为文档标题或文件名。
- 优化文件夹折叠/展开箭头,提高目录层级可见性。
11. 工具栏与分屏预览
- 编辑 Markdown 时,分屏预览按源码滚动比例跟随编辑区上下移动。
- 删除工具栏首页按钮,将后退、前进、打开、刷新改为图标按钮。
- 将工具栏 A-/A+ 改为文档字号下拉框,并增加文档字体下拉框。
- 编辑模式下调整文档字号时,同时调整预览窗口和源码编辑窗口字号。
- 编辑模式下在保存、另存为、取消前补充回退/前进按钮。
- 强化阅读/编辑模式目录连续点击跳转,避免首次正常后后续失效。
- 主工具栏移除页内查找框,将搜索/上一个/下一个移动到文档列表栏搜索框上方。
- 文档列表栏搜索框高度压缩为约当前字体 1.5 倍,并修复深色主题下字体/字号标签颜色。
12. 主题背景
- 默认主题颜色改为彩色。
- 删除旧主题背景选项,新增无、中国结、祥云、如意、毛笔、牡丹、竹、回纹。
- 为新增主题背景提供离线 SVG 纹样资源,并兼容旧配置中的背景值。
- 限制主题背景仅在主题颜色为彩色时可选,其他颜色自动使用“无”。
- 修改主题背景时同步刷新窗口图标和 MDHelper 标题栏颜色。
风险与注意事项:
- 冲突检测要避免误判,也要避免静默覆盖外部工具已经保存的内容。
- “另存为”后要同步文档树、最近文件、搜索索引、当前标签页标题和文件监听。
- 草稿不能直接覆盖正式文件,只能在用户确认后恢复。
- 分屏同步滚动只能做近似同步,Mermaid、公式和图片会让源码高度与预览高度不一致。
- 插入工具栏要操作选区,不能破坏已有文本。