Markdown Preview
Live Markdown preview
Live Markdown preview 在您的浏览器中本地运行
About the
当您键入时，Markdown 预览会在并排视图中呈现您的 Markdown，遵循 CommonMark 以及大多数人实际使用的 GitHub 扩展：表格、任务列表、隔离代码块、删除线和自动链接。这是在提交之前检查 README 的最快方法，因为 Markdown 在源代码中的外观与呈现的外观之间的差异并不明显，尤其是当单个管道或破折号错误时，表语法会默默地失败。如果您需要在不处理 Markdown 的地方使用渲染的 HTML，也可以将其复制出来。
Where people use the
- 在推送之前检查自述文件是否正确呈现。
- 起草发布说明或变更日志以及结果的实时视图。
- 对于不接受 Markdown 的 CMS，将 Markdown 文档转换为 HTML。
- 查看其他人的 Markdown Pull 请求并看看它会是什么样子。
How to use the
- 1
粘贴或编写您的 Markdown
编辑器接受从单个段落到包含标题、列表、链接和代码围栏的完整文档的任何内容。
- 2
观看渲染面板
每次击键都会更新预览，因此损坏的表格或未关闭的栅栏会立即显示，而不是在发布步骤之后显示。
- 3
修复源，而不是预览
预览是只读的。当某些内容呈现错误时，原因几乎总是在没有分隔符行的列表或表标题之前缺少空行。
- 4
如果需要，请复制 HTML
切换到 HTML 视图以获取生成的标记，这对于粘贴到需要 HTML 而不是 Markdown 的 CMS 中非常有用。
提示和最佳实践
- 每个块元素前后各留一个空行；最令人费解的渲染错误是缺少空行。
- 使用带有语言名称的隔离代码块，以便代码突出显示而不是被视为纯文本。
- 在长文档中每行保留一句话；它使差异稍后可读。
常见问题
使用哪种 Markdown 规范？
以 CommonMark 为基础，加上用于表格、任务列表、隔离代码和删除线的 GitHub Flavored Markdown 扩展。该组合涵盖了 GitHub、GitLab 和大多数文档网站上的 README 格式。
为什么我的表格没有呈现？
表格需要一个标题行，紧接着是一个由破折号组成的分隔符行，块之前有一个空行。每行的管道数量必须与标题相同。任何一个缺失都会将整个内容变成一段带有管道字符的文本。
为什么我的列表项合并为一个段落？
Markdown 需要在段落和其后的列表之间有一个空行。如果没有它，列表标记将被视为普通文本。
它支持 LaTeX 或数学吗？
不可以。数学渲染需要单独的库（例如 KaTeX 或 MathJax）和不同的语法。此处的美元符号表达式将呈现为纯文本。
是否允许原始 HTML？
是的，内联 HTML 直接通过，这也是 GitHub 所做的。如果您将输出发布到任何公开的地方，请首先对其进行清理，因为原始 HTML 也是注入脚本的方式。
我的文字去哪儿了？
无处。解析和渲染通过 JavaScript Markdown 库在浏览器中进行。不会保存或传输任何内容，因此当您关闭选项卡时，草稿就会消失，除非您将其复制出来。