公告 新用户注册即享 免费 SSL 证书 · 域名批量查询单次支持 40 个 · 香港与内地节点均可自助开通
解决方案 帮助中心 关于我们
代理合作 控制台 登录 免费注册

Markdown 预览

在左侧写 Markdown,右侧实时显示排版结果。标题、强调、列表、任务项、引用、代码块与表格都能识别,渲染过程不执行原始 HTML。

语法速查

Markdown 源文

0 字符
在左侧输入 Markdown,右侧会自动预览。

预览

0 字符

预览不加载外部资源,原始 HTML 不执行;链接显示为「文字(地址)」,图片显示为占位文字,不会发出请求。

语法速查 15 条常用写法、示例与常见错误,点击展开

下表是常用写法与本页预览的对应关系。两条基础规则贯穿全部语法:行首标记与内容之间要有空格,成对符号必须闭合;缺一条就会被当作普通文字输出。

结构写法说明
标题# 标题 到 ###### 标题井号与文字之间必须有空格,超过六级不识别。
段落空一行段内直接回车会被合并成同一段。
无序列表- 项目*、+ 也可以,符号后要留空格。
有序列表1. 项目数字不要求连续,渲染时按顺序重排。
任务列表- [ ] 待办 / - [x] 完成扩展语法,部分平台不支持。
粗体 / 斜体**粗体** / *斜体*符号必须成对,否则原样显示。
删除线~~文字~~扩展语法,同样需要成对。
行内代码`code`内部符号不再参与解析。
引用> 文字连续多行合并成同一个引用块。
代码块三个反引号包围开始与结束用同一种符号,结束行不短于开始行。
表格表头行 + --- 分隔行冒号控制对齐,单元格里的竖线写成 \|。
链接[文字](地址)本页预览显示为「文字(地址)」,不生成可点击链接。
图片![说明](地址)本页预览显示占位文字,不加载图片。
分隔线--- 单独成行三个以上的短横线、星号或下划线都可以。
转义\*、\|、\`反斜杠只对后面紧跟的一个字符生效。

常用示例

标题、列表与引用

# 服务说明
## 调用方式

- 请求地址:/api/order
- [x] 已配置密钥
- [ ] 已配置回调

> 同一幂等键在 24 小时内只生效一次。

带对齐的表格

| 参数 | 类型 | 说明 |
| :--- | :---: | ---: |
| host | string | 主机地址 |
| port | number | 端口号 |

分隔行里的冒号决定对齐::--- 左对齐,:---: 居中,---: 右对齐。列数由表头决定,数据行多出的单元格会被忽略。

代码块与行内代码

接口返回示例:

```json
{ "code": 0, "data": null }
```

行内提到字段时写 `orderNo`,不要加引号。

围栏内的井号、星号、竖线都按原文显示,不会被当作格式。写命令、配置片段、返回报文时优先用代码块。

链接、图片与转义

[文档中心](../../help/index.html)
![机房分布图](../assets/room.png)
价格按 5\*8 小时计费,参数分隔用 \| 。

地址里含空格或中文时先做 URL 编码(空格写成 %20),否则部分渲染器会把地址截断。

常见坑

  1. 表格缺了第二行分隔行,或用中文破折号、全角冒号,整张表会退化成普通文字。
  2. #标题 少一个空格,不会成为标题,只是普通段落。
  3. 列表与后面的段落之间没有空行,后面的文字会被并入最后一个列表项。
  4. 单元格里的竖线没有转义(例如链接参数里带 |),会把一列拆成两列。
  5. 代码块用四个空格缩进,这是早期写法,现在很多渲染器已不支持,统一用围栏更稳。
  6. 强调符号不成对,或星号紧贴文字,表现为星号原样显示。
  7. 图片地址含空格或中文没有编码,预览时看不出问题,上线后直接 404。
  8. 用了全角符号 #、*、|,这些是中文标点,不是 Markdown 标记。
  9. 平台扩展差异:任务列表、脚注、公式、自动链接、内嵌 HTML 各家支持不同,发布前以目标平台的渲染结果为准。
需要排版表格?用 Markdown 表格生成器 按行列填写后复制源码,比手写竖线更不容易错位。

这个工具做什么

Markdown 用少量符号表达结构:井号开头是标题,星号包裹是强调,短横线加空格是列表项,反引号包围是代码。写说明文档、接口备注、发布清单时,直接读源文不如看排版后的效果直观。这个工具把左侧的 Markdown 源文按常见规则解析,在右侧生成对应的标题、段落、列表、引用、代码块与表格,方便在发布前检查层级和格式是否写对。

解析器只在本页实现,不依赖任何外部库。处理顺序是先把文本按行切成块(标题、列表、代码块、表格等),再对块内的文字做行内解析(粗体、斜体、行内代码、删除线)。支持的语法范围写在页面下方的「使用限制与提醒」里,超出范围的写法会按普通文字显示,不会报错,也不会中断整篇渲染。

安全方面的处理是刻意保守的:整段输入始终被当作纯文本,构建页面元素时只用文本节点填充内容。原始 HTML 标签会原样显示成文字,链接不会生成可点击的锚点,图片不会生成图像元素,因此预览过程不会发起任何网络请求,也不会执行脚本。

怎么用

把 Markdown 粘贴到左侧输入框,停止输入约 200 毫秒后右侧自动刷新,不需要点按钮。右侧区域可以独立滚动,长文档不会把页面撑高。底部统计给出字数、行数与字符数,字数按非空白字符计算,行数按换行符切分。

如果某段写法没有按预期渲染,先检查符号是否成对、符号与文字之间是否有必要的空格。解析器不会自动纠错,缺少闭合符号时会把符号当作普通字符输出,这样比猜测意图更安全,也更容易定位问题。

结果怎么解读

块级结构

标题按层级显示为不同的字号,层级越深字号越小,但都不会生成页面级的主标题,因此预览里的标题不会影响页面本身的文档结构。列表项按源文顺序排列,有序列表保留起始编号;连续的任务项会显示方框,已完成的方框带勾选标记。引用块左侧有一条竖线,内部可以继续包含段落和列表。

表格要求第二行是分隔行,单元格由竖线分开。分隔行里的短横线数量不影响渲染宽度,冒号表示对齐方式,但本工具只做基础展示,不额外设置列对齐。表格外层可以横向滚动,列多时不会挤压页面。分隔线用三个以上的短横线、星号或下划线单独成行表示。

行内格式与占位显示

粗体用两个星号包裹,斜体用一个星号包裹,删除线用两个波浪线包裹,行内代码用反引号包裹。行内代码内部的符号不再参与解析,所以可以在代码里安全地写星号或下划线。强调符号必须成对出现,找不到闭合符号时会原样显示。

链接写成方括号加圆括号的形式,预览里显示为「文字(地址)」的纯文本,不会变成可点击的链接。图片写成感叹号加方括号加圆括号,预览里显示为「[图片:说明] 地址」的占位文字,说明为空时显示「[图片]」。这样处理是有意为之:预览阶段不需要访问目标地址,也不会因为一张外链图片暴露访问者的网络环境。

常见的几种情况

原始 HTML 标签显示成了文字

例如输入一段带尖括号的标签,右侧看到的就是这段标签本身,而不是渲染后的元素。这是预期行为。预览器不解析 HTML,也不做白名单过滤后再插入,而是从源头上不把输入当作标记。这样做的好处是不会因为粘贴了来路不明的内容而在页面里执行脚本;代价是确实需要 HTML 结构时无法在预览里看到效果。

表格没有渲染成表格

最常见的原因是第二行分隔行缺失,或者分隔行里的短横线被写成了中文标点。表格至少要有两行:第一行是表头,第二行由短横线和竖线组成。单元格数量不要求完全一致,缺少的单元格会留空,多出的会被忽略。如果表格出现在列表项后面且没有空行,解析器可能把它当成列表内容的一部分,补一个空行通常就能恢复。

代码块里的符号被当成格式

行内代码需要用反引号包住,多行代码需要用围栏代码块。只在行首缩进四个空格的传统写法不在支持范围内,会被当作普通段落。围栏代码块内部的内容完全按原文显示,星号、井号、竖线都不会触发格式解析,适合放配置文件片段或命令。

列表项里的文字没有换行

同一个列表项内的连续文字会合并成一段。需要在项内换行时,可以在行末留两个空格再换行,或者直接把内容拆成多个列表项。列表与上下段落之间最好留一个空行,否则解析器可能把紧随其后的文字并入最后一项。

使用限制与提醒

单次输入上限为 200,000 字符。超过上限时工具不会渲染半截内容,而是提示超限并保留上一次的预览结果。字符数按 JavaScript 字符串长度计算,中文算 1,emoji 等需要两个编码单元算 2。超长文档建议拆成多个文件分别预览。

语法支持范围是常见子集,不包含嵌套列表、引用内的表格、脚注、定义列表、数学公式、自动链接与 HTML 块。嵌套结构会按最外层解析,内层符号可能作为文字保留。解析器也不做 Markdown 规范的全部边界处理,例如连续强调符号、转义字符的组合、链接地址里的括号,都可能与标准实现有细微差异。

最重要的一点:这里的预览用于检查排版,不能当作最终发布效果。不同平台对 Markdown 的扩展不同,任务列表、表格、删除线的写法在部分系统里可能不被识别;链接和图片在真实页面上会被解析成可点击、可加载的元素,安全和隐私策略也与本页不同。需要发布时,应以目标平台的渲染结果为准。

本地处理:输入的 Markdown 只在当前标签页内解析和显示,不会上传,也不会写入本地存储。预览不加载任何外部资源,关闭页面后内容即消失。

下一步:把结果放到线上环境

Markdown 预览的结果要落地,还需要一台可用的服务器与运行环境,先确认 CPU、内存与带宽。

推荐产品 虚拟主机 帮助中心、文档站这类内容站用虚拟主机就够,PHP 与 MySQL 开箱可用。 查看空间与流量
需要协助 提交工单 部署或联调卡住时,把报错与配置贴进工单,7×24 小时有人跟进。 提交工单