预览结果显示在这里
工具说明
关于 Markdown 预览器
Markdown Preview 会把 Markdown 源文实时渲染成可读预览,方便检查标题、列表、链接、引用、表格和代码块。
适合在提交 README、文档片段、Issue 或博客草稿前快速确认排版。
如何使用 Markdown Preview
- 粘贴 Markdown 源文。
- 使用示例确认 GFM 表格、代码块和链接的渲染效果。
- 检查标题层级、列表缩进和链接是否符合预期。
常见使用场景
- 提交 README 前确认代码块语言和表格对齐。
- 写 GitHub Issue 或发布说明前预览结构。
- 把 API 文档片段粘进来检查标题和列表嵌套。
Markdown 语法和常见排版问题
Markdown 看起来简单,但空行、缩进和反引号数量都会影响渲染结果。GitHub Flavored Markdown 还支持表格、任务列表和围栏代码块。
- 标题使用 #,页面里建议保持层级递进。
- 列表嵌套依赖缩进,混用空格和 Tab 容易错位。
- 代码块用三个反引号包裹,并可标注语言。
- 链接文本应可读,不要只写“点击这里”。
Markdown 预览常见问题
- 支持 GitHub Flavored Markdown 吗?
- 常见 GFM 写法如表格、代码块和任务列表可用于预览,但最终效果仍以目标平台为准。
- 为什么列表没有嵌套成功?
- 通常是缩进或空行问题。子列表需要比父级多缩进,并保持符号风格一致。
- 内容会上传吗?
- 不会。Markdown 渲染在浏览器本地执行,不会上传到 wetool.site。
Markdown Preview 与正式发布
预览能发现大多数排版问题,但 GitHub、npm、论坛或 CMS 可能有自己的 Markdown 扩展和安全过滤,发布前仍要在目标平台复核。
Markdown 方言差异对照
预览工具能帮你发现结构问题,但不同平台的 Markdown 方言并不完全一致。
- CommonMark 覆盖标题、段落、列表、引用和代码块等基础语法。
- GitHub Flavored Markdown 增加表格、任务列表、删除线和自动链接等常见扩展。
- 博客、CMS 和文档站可能额外支持 front matter、目录锚点、脚注或数学公式。
安全渲染与发布边界
Markdown 预览不是正式发布环境,尤其要注意 HTML、图片、外链和平台过滤规则。
- 不要把未信任 Markdown 当作安全 HTML;目标平台通常会 sanitize 原始 HTML。
- 外部图片和链接在正式发布后可能暴露请求来源、token 参数或内部地址。
- 发布 README、npm 文档或 CMS 页面前,仍要在目标平台复核最终渲染效果。