MV Tools

真实的 Markdown 发布检查

如何编写、预览和发布 Markdown,避免格式意外

适用于 README、文档、笔记和网页内容的实用流程:编写可移植 Markdown,预览有代表性的内容,并在实际发布渲染器中确认结果。

MV Tools 编辑团队更新于 约 8 分钟阅读

打开工具

把 Markdown 当作源格式,而不是最终外观保证

Markdown 的设计本就简洁,但各平台会自行选择渲染器、扩展、主题、清理规则,以及链接、表格、换行和 HTML 的处理方式。因此,一个预览中正确的文档,到了代码托管平台、CMS、问题跟踪器、知识库或邮件客户端后仍可能不同。

让源文件脱离特定主题也能表达清楚含义:目标平台需要时使用一个说明明确的一级标题,按逻辑顺序安排标题,用真正的列表表示列表,用围栏代码块表示代码。发布长文前,先在实际目标中预览一段有代表性的内容。

用一份有代表性的草稿检查最终发布平台必须支持的语法。
用一份有代表性的草稿检查最终发布平台必须支持的语法。

润色前先建立可复核的结构

先写大纲:标题、简短目的说明、读者需要的主要部分以及明确的下一步。标题级别应表达层级,而不是用加粗或空行代替。二级标题直接跳到四级标题会降低可扫描性,也会让使用导航工具的读者更难理解结构。

链接文字应说明将打开什么内容。URL 是目标时可用尖括号或 Markdown 链接,不要只写含糊的“点击这里”。使用表格前先确认目标支持 Markdown 表格,并保持单元格简短;在小屏幕上,紧凑列表通常比宽表格更易读。

用一份有代表性的草稿检查最终发布平台必须支持的语法。
用一份有代表性的草稿检查最终发布平台必须支持的语法。

预览最容易误读的语法

发布前,请加入一小段你真正依赖的功能测试:嵌套列表、带查询参数的链接、行内代码、带语言标记的围栏代码块、引用、需要时的表格和非 ASCII 文字。检查代码字符没有被替换为排版标点,有意的段落分隔也没有被折叠。

MV Tools 使用 markdown-it 渲染预览:禁用原始 HTML,因此会显示为已转义文本;开启自动链接和排版替换;普通换行不会自动转为 `<br>`。这些是本地检查设置,并不代表发布平台一定采用相同规则。

此工具会转义原始 HTML;请在最终发布平台核对其规则。
此工具会转义原始 HTML;请在最终发布平台核对其规则。

将原始 HTML 和导出 HTML 放在正确位置

一个 Markdown 预览可能转义原始 HTML,而另一个系统可能允许、移除或以不同方式清理它。不要认为预览就能让任意 HTML 安全发布。目标允许用户提供 HTML 时,应采用该平台文档规定的清理和渲染策略,绝不能把不可信字符串拼接进 HTML 或脚本上下文。

工具可复制渲染后的 HTML,或下载基础 HTML 文档。导出文件包含渲染正文和文档元数据,但没有样式表和页面资源;它适合检查生成标记或作为简单起点,而不能证明结果会与带主题网站、PDF 生成器、邮件客户端或 CMS 模板一致。

此工具会转义原始 HTML;请在最终发布平台核对其规则。
此工具会转义原始 HTML;请在最终发布平台核对其规则。

用小而可重复的检查表发布

保留原始 `.md` 文件作为正式源。用窄屏检查预览,打开所有重要链接,并检查代码、表格、标题和引用内容。在可以使用最终渲染器的地方先发布小型示例或草稿,再与本地预览对照;发现方言差异后再更新完整文档。

此 Markdown 工具在浏览器本地运行:编辑、渲染、复制和 data URL 下载不会上传文档到 MV Tools。本地处理只能减少一种暴露路径,并不改变你对秘密信息、个人数据、内部链接或版权内容的处理责任。排错时使用脱敏样例,并遵守最终发布系统的规则。

用一份有代表性的草稿检查最终发布平台必须支持的语法。
用一份有代表性的草稿检查最终发布平台必须支持的语法。

常见问题

为什么发布后的 Markdown 与预览不同?

目标平台可能使用不同渲染器、扩展、主题、HTML 策略、换行规则或 CSS。请用有代表性的样例在实际平台验证。

此预览允许原始 HTML 吗?

不允许。它的 markdown-it 配置禁用了原始 HTML,因此会作为文本转义显示;其他发布系统可能不同。

下载的 HTML 能直接作为完整网页吗?

它是没有样式和站点资源的基础 HTML 文档。可用于检查或作为起点,但应加入合适设计并在最终环境中测试。