使用方法
- 在编辑器中输入 Markdown,或点击“试用示例”加载包含表格和任务列表的文档。
- 输入时可实时查看预览。切换到“HTML 源码”查看生成的标记。
- 根据文本的发布位置,开启或关闭 GitHub Flavored Markdown 或单行换行选项。
- 将 HTML 复制到 CMS 或电子邮件中,或将结果下载为 .html 或 .md 文件。
工作原理
Markdown 使用 marked 转换。marked 是一款广泛使用的开源解析器,支持 CommonMark 规范;开启 GFM 选项后,还支持 GitHub Flavored Markdown:带列对齐的管道表格、任务列表、~~删除线~~,以及对纯 URL 自动创建链接。脚注、数学公式和 Mermaid 图表不属于这些规范,会以纯文本显示。
Markdown 可能包含原始 HTML,与大多数 Markdown 渲染器一样,这些 HTML 会原样保留。为保障安全,预览内容不会插入此页面,而是在沙盒框架中渲染。该框架禁止运行脚本、提交表单、打开弹出窗口或访问此网站;其内容安全策略还会屏蔽脚本、外部样式表、字体和框架。Markdown 中的 <script> 标签或 onclick 属性会显示在 HTML 源码中,但不会执行。预览中的链接会显示出来,但无法打开;如需访问,请复制 URL。
预览使用与常见 README 渲染器类似的中性样式表;你的网站或 GitHub 可能会以不同方式显示相同的 HTML。复制的 HTML 是不含样式的纯片段;下载的 .html 文件会添加基本样式表,使其外观与预览一致。下载或复制的 HTML 不会经过净化,因此如果其中包含脚本,这些脚本会在你粘贴或打开 HTML 的位置运行。
示例
推送前检查 README
粘贴 README.md,检查表格列是否对齐、任务列表是否显示为复选框,以及代码块是否正确使用围栏标记,然后再将文件推送到 GitHub。
为支持 HTML 的 CMS 撰稿
用 Markdown 撰写博客文章草稿,然后点击“复制 HTML”,将 <h2>、<p> 和 <ul> 标记粘贴到 CMS 的 HTML 编辑器中。
聊天风格的换行
聊天应用中的文本行之间以单个换行符分隔。开启“将单个换行符视为 <br>”后,各行会保持分开,而不会合并到同一段落中。
常见问题
粘贴来自未知来源的 Markdown 安全吗?
可以,用于预览是安全的。渲染后的 HTML 会显示在禁用脚本的沙盒框架中,因此文本中的 <script> 标签或事件处理程序在这里都不会执行。将导出的 HTML 粘贴到其他位置时请注意,因为它未经净化。
为什么图片没有显示?
默认会屏蔽来自其他网站的图片,以确保预览不会发出网络请求。开启“加载来自其他网站的图片”即可显示这些图片。由于相关文件不在此处,因此 ./docs/screenshot.png 这类相对路径无法使用。
支持脚注、数学公式或图表吗?
不支持。它支持 CommonMark 和 GitHub Flavored Markdown(表格、任务列表、删除线、自动链接)。脚注、LaTeX 数学公式和 Mermaid 图表属于扩展语法,在此预览中会以纯文本显示。
为什么单个换行符不会另起一行?
在标准 Markdown 中,段落内的单个换行符会被视为空格。可在行尾添加两个空格、留一个空行,或开启“将单个换行符视为 <br>”。
隐私
Markdown 在浏览器中转换,不会上传或存储。除非你允许加载来自其他网站的图片,否则预览不会从互联网加载任何内容;允许后,图片会直接从其所在网站请求。