Markdown Preview

One input per line. Output is numbered to match the input order.
Pinned tools are listed in your favourites on the home page.Copies a link to this tool that carries your current input, so it opens ready to run.Gives you an iframe snippet for putting this tool on your own site.
Markdown
Preview
Ctrl+Enter Run  · Ctrl+Shift+C Copy  · Esc Clear

Understand Markdown Preview

这个预览会随你输入把 Markdown 渲染成 HTML,让你看到 README 或长篇评论最终呈现的样子。

How it works

Markdown 由一组按顺序应用的规则转换:先是围栏代码块,好让其中的内容被转义并原样保留,然后是标题、引用块、分隔线、列表、行内代码、加粗、斜体和链接。生成的 HTML 会经过一份白名单过滤——标题、段落、列表、code、pre、strong、em、blockquote、hr、br 和链接——除了 http、https 或 mailto 的 href 之外的所有属性都会被丢弃,因此源文中的原始 HTML 无法执行。

When to use it

  • 在推送之前检查 README 的标题层级和代码围栏。
  • 看看一段很长的 issue 正文或评论是否会按你的意图渲染。
  • 把 Markdown 片段转成可粘进 CMS 或邮件的 HTML。
  • 测试列表或嵌套代码块是否写对了。

Watch out for

  • 这是 CommonMark 的一个子集,不是 GitHub 风味 Markdown。表格、任务列表、删除线、脚注和图片不会被渲染——取而代之的是它们的源文本原样显示。
  • 词内部的下划线会被读作强调,因此 snake_case_name 渲染出来中间那个词是斜体。CommonMark 刻意不这么做;请把标识符用反引号包起来。
  • 嵌套支持很浅。引用块内部的列表,或缩进的子列表,都不会呈现出完整解析器所产生的效果。
  • 源文中的原始 HTML 会被净化器降级为它的文本内容。这是有意为之,也让本预览比 GitHub 更严格,后者允许有限的一组标签。

Not the right tool for: 确认 GitHub 究竟会如何渲染一个文件。GitHub 在 CommonMark 之上叠加了自己的扩展和自己的净化器;若要逐字节核对,请推送到一个分支去看。

Frequently Asked Questions

支持哪些 Markdown 语法?

CommonMark 规范:# 标题(1-6 级)、**加粗**、*斜体*、`行内代码`、```围栏代码块```、[链接](url)、![图片](url)、- 无序列表、1. 有序列表、> 引用块、--- 分隔线,以及 | 表格 | 语法。

如何预览 GitHub 的 README?

把 README.md 的内容粘进编辑器。GitHub 使用严格的 CommonMark 解析器,并附加了 GFM(GitHub 风味 Markdown)扩展以支持任务列表、表格和删除线。本预览与 GitHub 的渲染结果相当接近。

可以导出渲染后的 HTML 吗?

可以——点击「复制 HTML」即可获得渲染后的 HTML 输出。这适合把格式化内容粘进邮件客户端、接受 HTML 输入的 CMS 系统,或 HTML 邮件模板。

How to Use Markdown Preview

  1. Paste or type your input in the input area above.
  2. The tool processes your input automatically or click Run.
  3. Copy or download the result using the action buttons.
  4. Use Ctrl+Enter to run quickly from the keyboard.