返回 网站动态
DevTool 团队

Markdown 在线预览指南:GFM、Mermaid、数学公式与隐私

系统了解 Markdown 在线预览:检查 GFM 表格、任务列表、代码高亮、Mermaid、KaTeX、HTML/PDF 导出,以及本地文件与远程 URL 的隐私边界。

在线预览 Markdown 解决的不是“看文字”而是“看结果”

Markdown 源码任何文本编辑器都能打开,但源码正确不代表渲染一定符合预期。表格少一个分隔符、代码围栏没有闭合、标题层级跳跃、Mermaid 语法错误,都可能在最终页面才暴露。

Markdown 在线阅读器把源码编辑、实时预览和目录放在同一页面,适合在提交文档前快速检查。它不替代 GitHub、文档站或静态站生成器的最终构建,而是提供一个更快的第一轮反馈。

先确认你需要哪一种兼容性

标准 Markdown

标题、段落、强调、引用、列表、链接、图片和围栏代码块构成最常见的基础。不同解析器对空行、缩进和嵌套列表的容错可能不同,因此建议使用明确、简单的写法,不依赖偶然可用的格式。

GitHub Flavored Markdown(GFM)

README 和开发文档常用 GFM 扩展,包括:

  • 表格、任务列表与删除线;
  • 自动识别 URL;
  • 围栏代码块和语言标识;
  • 与 GitHub 风格接近的换行和列表处理。

预览器支持 GFM 并不等于完全复刻 GitHub。仓库相对链接、issue 引用、用户名提及、徽章图片和允许的 HTML 标签仍依赖平台上下文。

预览 GFM 表格与任务列表

表格至少需要表头和分隔行:

| 状态 | 工作项 |
| --- | --- |
| 完成 | 检查标题层级 |
| 待办 | 验证移动端表格 |

- [x] 检查链接
- [ ] 检查图片替代文本

预览时观察三件事:列是否正确对齐,长内容在窄屏是否需要横向滚动,任务项是否被错误地放入普通列表。复杂表格通常不适合移动端,可考虑拆成小表格或列表。

代码块、高亮与复制

围栏开头的语言标识决定高亮方式,例如 typescriptpythonjson。标识写错通常不会破坏内容,但会退回纯文本显示。不要仅靠颜色传达含义;代码自身应保持可读。

在线预览适合检查围栏是否闭合、缩进是否被误解析,以及长代码行是否溢出。真正的代码正确性仍需要编译器、测试或对应运行时验证。

Mermaid 图表如何预览

把图表放在语言为 mermaid 的代码围栏中:

```mermaid
flowchart LR
  Draft --> Preview
  Preview --> Review
  Review --> Publish
```

Mermaid 不是 Markdown 标准的一部分。若目标平台不支持,可以保留源码并导出图片作为兼容方案。预览器采用严格安全模式渲染,但仍建议不要从未知来源复制包含可疑链接或复杂指令的图表。

KaTeX 数学公式与扩展语法

行内公式通常写作 $E = mc^2$,块级公式使用成对的 $$。KaTeX 支持大量常用 LaTeX 命令,但不是完整 TeX 引擎;过于依赖宏包的公式可能无法渲染。

脚注、GitHub Alerts 和 emoji 也属于扩展能力。发布前要以目标系统为准:在一个预览器中显示成功,只能说明该预览器支持,不能证明所有平台都支持。

本地文件、raw URL 和分享链接的隐私差异

三种输入方式的网络边界不同:

  1. 选择本地文件或粘贴文本:本站工具在当前浏览器中读取和渲染内容。
  2. 加载 raw URL:浏览器必须请求你提供的远程地址,目标主机会看到正常网络请求。
  3. 创建分享链接:正文编码在 # 后的 URL fragment 中,fragment 不会作为 HTTP 请求的一部分发送到本站服务器,但完整链接仍可能被浏览器历史、剪贴板、聊天软件或收到链接的人保存。

因此,含密钥、访问令牌、客户数据或未公开源码的文档不应通过分享链接传播。使用第三方在线工具时也应单独核对其实现和隐私政策,不能把本站行为推断到其他服务。

导出 HTML 与 PDF 前检查什么

  • 标题层级从 H2/H3 逐级展开,不依赖字号模拟结构;
  • 链接文字能说明目的,图片有替代文本;
  • 表格和代码块在打印宽度内可读;
  • 外部图片在离线或受限网络中是否仍可访问;
  • 原始 HTML 是否被安全清理或直接禁用。

本站工具可导出清理后的 HTML,也可调用浏览器打印界面保存 PDF。导出结果用于归档很方便,但如果文档由代码生成,仍应保留 .md 源文件作为可维护版本。

推荐的提交前流程

  1. 在编辑器中完成 Markdown 源码并运行拼写、链接或文档构建检查。
  2. 用在线预览快速检查 GFM、代码块、公式与 Mermaid。
  3. 切换窄屏,检查表格、长 URL 和代码是否溢出。
  4. 在最终目标平台复核相对图片、锚点和平台专属语法。
  5. 确认文档没有凭据或不应公开的信息后再提交或分享。

如果你的重点是仓库首页,可继续阅读README.md 在线预览检查清单;如果只是收到一个未知扩展名的文件,则先看.md 文件打开方法