Hello Markdown
A bold and italic sample with a link.
列表
- item one
- item two
- item three
代码
const greet = (name) => `Hello, ${name}!`
console.log(greet('world'))
A blockquote with emphasis.
| Header | Value |
|---|---|
| Alpha | 1 |
| Beta | 2 |
关于 Markdown 预览
用 Markdown 写东西最大的不确定性来自「我看到的源码和别人看到的渲染结果是否一致」:表格少了一根竖线会让整块结构崩掉,列表前多空一行会变成另一种嵌套,而这些问题在纯文本编辑器里完全看不出来。预览工具的价值就是把源码即时渲染成最终形态,让格式问题在写完的当下就暴露。 Markdown 是「纯文本标记 + 渲染规则」,同一份源码在不同实现下可能产出不同的 HTML:是否允许在段落中直接嵌入 HTML、表格与任务列表属于哪个扩展、换行是软换行还是硬换行,各家默认值不同。因此预览时除了看效果,还要意识到「这里的渲染结果与目标平台未必完全一致」,尤其是博客平台、代码托管平台与笔记软件各自有不同扩展集。 使用要点:先确认目标平台的方言,如果最终要发布到某个平台,优先使用该平台支持的语法子集,避免用到只有某个实现才有的扩展;表格与代码块最容易出问题,写完先检查表格列数是否与分隔行一致、代码围栏是否成对闭合。列表的缩进要与其标记宽度对齐,否则本该嵌套的内容会被解析成代码块,这是最常见的「明明对齐了却渲染不对」。最后,标题层级不要跳级,它同时影响目录生成与无障碍读屏的导航结构。 边界与限制:Markdown 的设计目标之一是「尽量可读的纯文本」,因此它无法表达复杂排版,需要精细排版的场合应改用富文本或专门的标记语言;Markdown 也没有统一的规范,CommonMark 只是共识基线,扩展语法(脚注、定义列表、数学公式)在实现之间差异更大,跨平台发布前建议逐项核对。另外渲染结果中的链接与图片会触发外部请求,若文档中含内部地址或追踪参数,预览时留意网络面板。还有一点容易忽略:许多平台会在渲染后再次做安全过滤,允许的标签白名单各不相同,因此本地方可正常显示的嵌入内容在平台上可能被剥离。 数据与隐私:草稿里往往包含尚未发布的公告、产品说明与内部链接。本工具在浏览器内完成渲染,不上传草稿,也不需要联网即可查看纯文本部分的效果;含内部链接的文档建议在网络面板可见或离线状态下预览。
如果文档最终要进入某个文档站生成器,那么预览只能作为第一道检查,真正的验收标准是生成后的站点页面。生成器通常会在 Markdown 之上再叠加一层能力,例如自动生成目录、把标题转成锚点、为代码块加语言高亮,这些都在渲染阶段完成,纯预览看不到。因此发布前应在目标环境里打开实际页面,逐项确认目录层级、锚点跳转与代码高亮是否正常,并检查外部图片与链接是否可访问,避免出现「本地好好的、线上图裂了」这类问题。 把预览与目标环境各看一遍,再提交,是文档类改动成本最低的验收方式。
实现原理
预览把纯文本按渲染规则转成标记语言结构。同一份源码在不同实现下可能产出不同结果:是否允许内联标记语言、表格与任务列表属于哪个扩展、单个换行是软换行还是硬换行,各家默认值不同。因此预览只能确认语法,不能替代在目标平台上实测。
| a | b |\n| --- | --- |\n| 1 | 2 |支持表格扩展时渲染成表格;不支持的实现会原样输出竖线文本使用方法
- 打开「Markdown 预览」
- 粘贴待处理的文本
- 根据需要调整输出选项
- 点击「处理」按钮,结果实时显示
- 复制或导出结果
使用场景
- README 预览 — 提交到仓库前先确认标题层级、徽章和代码块渲染是否正常。
- 博客草稿 — 在发布到静态站点前预览文章排版,检查图片与链接。
- 语法学习 — 实时对照输入与输出,快速掌握表格、任务列表等 Markdown 写法。
- 文档评审 — 把 Markdown 渲染后截图,方便不熟悉语法的同事审阅内容。
- 代码片段 — 检验围栏代码块的语言标注与缩进在渲染后是否正确。
- 发布前检查 — 验证图片相对路径、锚点链接在渲染后是否可用,避免上线后断链。
常见问题
支持哪种 Markdown 方言?
支持常用的 CommonMark 基础语法及表格、删除线、任务列表等常见 GFM 扩展,覆盖日常写作需求。
能渲染 HTML 标签吗?
出于安全考虑,内嵌的脚本类 HTML 不会被执行,避免预览时触发恶意代码。
数学公式能显示吗?
基础版本聚焦文本与代码渲染,复杂的 LaTeX 公式可能不支持,建议用专门的公式工具。
可以导出成 HTML 吗?
你可以直接复制渲染区域的内容,或从源码复制 Markdown;如需结构化转换可配合本站其它格式工具。
粘贴的图片链接不显示?
预览会按链接加载图片,若图片需要登录或有防盗链限制,浏览器可能无法显示,这与解析无关。
GFM 和 CommonMark 有何差别?
GFM 是建立在 CommonMark 之上的 GitHub 扩展,新增了表格、任务列表、删除线等语法;纯 CommonMark 解析器不认这些,跨平台粘贴时要注意兼容。
预览和 GitHub 渲染不一致?
GitHub 用 GFM 扩展(任务列表、删除线、自动链接、表格),部分 Markdown 实现默认不开。先确认你用的语法是否属于 GFM;不一致的常见点是换行处理(GitHub 把单换行渲染成换行,标准 Markdown 不换)。
表格渲染不出来,检查了语法也没问题?
表格的表头分隔行(| --- |)前后都需要空行,且分隔行的连字符数量没有硬性要求但管道符要对齐列数。最隐蔽的错误是表格前一行直接顶着文本——Markdown 解析器会把它当成上一段的延续。