使用文档

开始使用 oh-my-md 写作

面向本地文件的轻量桌面 Markdown 编辑器,专为应对万行至几十万行的大型文档而设计。在下载页面获取适合你系统的安装包。

快速上手与工作区

oh-my-md 遵循 100% 本地优先原则。没有强制云端同步账号、没有私有格式数据库,所有内容直接存放在你电脑中的纯文本 Markdown 文件里。

单文件打开模式

在访达(Finder)或 Windows 文件资源管理器中双击任意 .md.markdown,即可秒开编辑,资源占用极小。

文件夹工作区模式

挂载任意本地文件夹作为工作区,解锁左侧文件树、全目录搜索、大纲 TOC 提取及多标签页管理。

本地图片存放约定: 粘贴或拖放插入的截图会自动保存到当前文档同级的 assets/ 目录中,使用相对路径链接,极易被 Git 管理和分享。

Live 预览与源码模式

传统分栏编辑器一边看源码一边看预览,白白浪费屏幕空间。oh-my-md 基于成熟的 CodeMirror 6 引擎构建了真正的所见即所得体验:

  • Live 预览模式: 星号、括号、数学分隔符等标记在输入时自然淡出,就地渲染出高精度的标题、表格与富内容块,同时光标依然停留在原文位置随时可编辑。
  • 源码模式: 随时按下 ⌘ E(或 Ctrl + E)即可切回带有完整语法高亮的纯源文本视图。

双模式切换是在底层文档树上增删装饰层(Decorations),不重新构建 DOM,因此切换瞬时完成且绝不丢字。

支持的 Markdown 与富内容块

完整遵循 CommonMark 与 GitHub Flavored Markdown (GFM) 规范,并支持现代学术和技术文档常用扩展:

GFM 表格与任务列表

交互式整齐对齐的表格呈现,支持删除线与可点击勾选的任务待办复选框。

KaTeX 数学公式

支持行内公式 $E=mc^2$ 与居中独立块 $$...$$,实时具备 LaTeX 级排版精度。

Mermaid 图表渲染

```mermaid 代码块内直接渲染流程图、时序图、架构拓扑与状态机图表。

Shiki 语法高亮

与 VS Code 代码高亮同源的精准着色,并自动跟随明暗主题切换配色。

常用快捷键速查

所有指令都可以通过命令面板搜索找到(⇧ ⌘ P / Ctrl + Shift + P)。以下为日常最高频的操作:

操作 macOS Windows / Linux
切换 Live 预览 / 源码模式 在原位实时渲染与底层纯文本间即时切换 ⌘ E Ctrl + E
命令面板 检索并执行全部编辑器动作 ⇧ ⌘ P Ctrl + Shift + P
粗体 ⌘ B Ctrl + B
斜体 ⌘ I Ctrl + I
插入链接 ⌘ K Ctrl + K
1 至 6 级标题 ⌘ 1 – 6 Ctrl + 1 – 6
打字机 / 专注模式 ⌥ ⌘ T Alt + Ctrl + T

大文档性能与架构保证

oh-my-md 的核心承诺:你永远不必因为编辑器卡顿而把长篇文档拆成许多碎片文件

与把整个文档全量转成巨大网页 DOM 的 Electron 方案不同,oh-my-md 结合了视口虚拟化与 Tauri 2 原生 Rust 外壳:

  • 视口窗口化渲染: 仅对当前屏幕可见区域内的行进行 DOM 挂载。离开屏幕的复杂公式或图表在后台按行高占位,不拖慢滚动帧率。
  • 增量局部解析: 单击键盘输入时只重新计算光标附近的语法节点与装饰种子,无论文档有 1 万行还是数十万行,打字延迟都能维持在帧预算内。
  • 保护性原子保存: 存盘走 Rust 双重指纹比对机制,绝不静默覆盖外部变动,杜绝闪退丢字。

系统提示与问题排查

当前 v0.0.1 发布版本覆盖 macOS Universal、Windows x64 与 Linux x64:

  • HTML 导出: 支持全平台导出完整渲染的单文件网页。
  • PDF / PNG 导出: 目前仅支持 macOS 平台通过系统原生 WebView 打印管线输出。

未签名社区构建说明: 当前首发版本未完成商业代码签名。macOS 用户若被 Gatekeeper 拦截,请在“应用程序”中按住 Control 键点击应用选择“打开”,或在终端运行 xattr -cr /Applications/oh-my-md.app。Windows 用户如遇 SmartScreen 提示,请核对校验和后点击“更多信息 → 仍要运行”。

遇到异常问题?请参阅主 README 与项目的手动测试记录,或前往支持中心提交附带复现步骤的 Issue。