跳到主要内容
Tooletto

Markdown 预览

Markdown 转 HTML 的预设方案

编写 Markdown,即时看到渲染效果。适合在提交之前起草一份 README、一段 Pull Request 描述或文档——预览被隔离在一个沙盒 frame 里,所以粘贴的内容无法运行任何东西。

  • 文件永不离开你的设备
  • 免费,无需注册
  • 无水印
  • 加载后可离线使用
Loading tool…

如何Markdown 转 HTML

  1. 1

    编写或粘贴 Markdown

    HTML 和预览都会随输入即时更新。

  2. 2

    查看预览

    在一个沙盒 frame 里渲染,所以粘贴的内容无法运行脚本。

  3. 3

    复制 HTML

    复制标记内容,或下载为 .html 文件。

为什么带预览地起草比凭空猜测原始语法更好

Markdown 最大的吸引力在于它可以像纯文本一样写、也像纯文本一样读,但正是这种朴素,让某些错误在渲染出来之前完全看不出来——一个表格的分隔行里缺了一个竖线字符,会悄悄退化成一个普通段落显示,而不是一张表格;一个缩进的空格数不对的嵌套列表,会挂到错误的父级列表项下面;这两个问题都不会有任何错误提示,只是输出结果悄悄地不像预期的那样。在写作的同时持续看到实际渲染出来的结果更新,恰好能在这类格式错误刚被引入的那一刻捕捉到它,这比盲写一整份 README 或 Pull Request 描述、直到它已经发布出去之后才发现格式坏了要快得多。

针对特定的目标场合起草内容

GitHub、一个文档站点和一篇论坛帖子,即使都大体支持 GFM,在边界情况下渲染同一份 Markdown 源码的方式也可能略有不同,所以在发布之前先预览,在目标场合是一处渲染错误会被大量读者看到的地方尤其值得——一份公开的 README、一份发布公告,或者一段审阅者会真正仔细阅读的 Pull Request 描述。

常见问题

支持哪种 Markdown 方言?

GitHub Flavored Markdown:在 CommonMark 核心之上,支持表格、围栏代码块、任务列表、删除线和自动链接。这正是 GitHub、Reddit 以及大多数静态站点生成器使用的方言。

粘贴来自不可信来源的 Markdown 安全吗?

预览是在一个禁用了脚本执行的沙盒 iframe 里渲染的,所以嵌入的 `<script>` 标签和事件处理器都无法执行。但要注意*生成的 HTML* 依然会包含你 Markdown 里原有的任何原始 HTML——在发布你自己没有编写的内容之前,请在服务器端先做一次消毒处理。

支持 Markdown 里的原始 HTML 吗?

支持——Markdown 允许内联 HTML,并且会原样传递。这正是为什么上面那条关于消毒处理的提醒,在来源不可信时很重要。

为什么我的表格没有渲染出来?

GFM 表格需要在表头下面有一行由短横线组成的分隔行,而且如果表格紧跟在一个段落后面,前面还需要一个空行。分隔行里哪怕缺一个竖线,都会让整个表格悄悄退化回纯文本。