Markdown预览
免费安全的Markdown HTML预览工具。
在浏览器里预览 Markdown
左侧写 Markdown,右侧即刻现出渲染的结果。标题、强调、链接、列表、引用、分隔线以及围栏代码块,均在支持之列。
**要留意的是,Markdown 并无单一的官方规范。** 2004 年最初的写法留下了不少未定之处,于是 GitHub、CommonMark 等各家在嵌套列表、换行、词中下划线一类的细处上并不一致——在一处看来无误的文档,换个地方呈现便可能两样。尤其常被绊住的是换行:**多数处理系里,一次换行并不会在段落内断行**,须在行尾留两个空格,或夹一个空行。
本工具在预览之前会把原始 HTML 转义,故而粘贴来的内容无从在此执行脚本。
Markdown 预览的用法
- 粘贴或写下 Markdown 在左侧编辑器里输入,预览会随即更新。
- 查看渲染的结果 发布之前,先核对标题、列表、链接与代码。
- 按需复制 HTML 可把生成的安全 HTML 复制到相容的编辑器中。
用好本工具的小技巧
- 以三个反引号围起代码,可原样保住源码的缩进与符号。
- 本预览有意把原始 HTML 以文本呈现,为的是减低脚本注入之险。
- 表格与嵌套列表最易因缩进深浅而走样,宜对着预览逐行调整。
这些场景会用到
边写 README 边确认时
**写作环境里所见,未必与 GitHub 上呈现的一致。** 推送之前,先看一眼为宜。
调整表格与嵌套列表时
结果随符号位置与缩进深浅而变的地方,用眼睛看着改,比推敲来得快。
把文章转成 HTML 带走时
**生成的 HTML 可照原样复制**,用作粘进内容系统之前的底稿正合适。
把给人的资料做成 PDF 时
用 Markdown 写下的操作手册与笔记,可整理成可直接分发的样子。
一边记住记法一边写时
**输入与结果并排,哪一个符号变成什么,试着试着便记住了。**
Markdown 的术语
- Markdown
- 以符号标示标题与强调的轻量记法。**并无单一的官方规范,各处理系之间存有差异。**
- CommonMark
- 把原先含混之处严格定下的规范。如今多数实现以它为底。
- GitHub Flavored Markdown
- 在 CommonMark 之上添了表格、删除线、任务列表的扩展。**GitHub 上的呈现依此而定。**
- 换行的处理
- **多数处理系里,一次换行并不会在段落内断行。** 须在行尾留两个空格,或夹一个空行。
- 围栏代码块
- 以三个反引号围起的一段。在起始处标上语言名,便能着色。
- 净化
- 把粘贴来的 HTML 中危险的元素剔除的处理。**本预览为安全呈现而施行此举。**
常见问题
不会。渲染与复制都在您的浏览器内就地完成。
不会。原始 HTML 一律转义,以文本呈现。
支持常用的书写记法,含标题、强调、链接、列表、引用、分隔线与围栏代码块。
多数 Markdown 处理系里,一次换行不作段落内的断行。请在行尾留两个空格,或夹一个空行。
为何发布之前要先预览
Markdown 写来轻省,可少一个符号便足以改变整页的结构。有了即时预览,标题、链接与列表的模样在粘进 README、议题、维基或内容系统之前便一目了然。
本工具宁取一套安全的通用子集,也不去执行任意的 HTML。如此一来,无论是核对自不明来源复制来的内容,还是起草自己的文字,都用得顺手。