Markdown 预览
Markdown 是一种使用纯文本语法创建格式化文本的轻量级标记语言。广泛用于文档、README 文件和笔记，渲染为 HTML 显示。此工具预览 Markdown 并实时渲染，提取文档结构（标题、链接、图片），并可转换为 HTML。
规范
常见用例
- 在提交前预览 README.md 文件
- 审查文档格式
- 从文档中提取所有链接进行验证
- 将 Markdown 转换为 HTML 用于嵌入
- 分析文档结构和导航
功能
- 带 HTML 渲染的实时预览
- 提取文档结构（标题作为目录）
- 列出文档中所有链接和图片
- 检测并显示带语言提示的代码块
- 解析 Frontmatter（YAML 元数据）
- 转换为干净的 HTML 输出
- 字数和字符数统计
示例
带功能列表的 README
试试看 →一个带标题、列表和代码的典型项目 README。
# My Project
A brief description of what this project does.
## Installation
```bash
npm install my-project
```
## Features
- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework
## Links
- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)提示
- 使用 # 表示标题（# H1、## H2、### H3 等）。
- 代码块使用三个反引号，可选语言标识符。
- 链接使用 [文本](url) 语法；图片使用 。
- --- 行之间的 Frontmatter 可包含 YAML 元数据。
理解 Markdown 预览
Markdown 是一种由 John Gruber 于 2004 年创建的轻量级标记语言，设计为纯文本形式也可阅读，同时能干净地转换为 HTML。其语法使用视觉上暗示格式的标点字符：# 表示标题、* 表示强调、- 表示列表、反引号表示代码。即使不渲染，Markdown 文件也很有用，这就是为什么该格式在文档、README 文件和技术写作中占主导地位。
CommonMark 规范（2014 年）解决了原始 Markdown 的许多歧义。CommonMark 精确定义了边缘情况的处理方式，大多数现代解析器都实现了它。GitHub Flavored Markdown（GFM）在 CommonMark 基础上扩展了表格、任务列表、删除线、自动链接 URL 和带语法高亮的围栏代码块。
GFM 是 README 文件、Pull Request 描述、Issue 评论和文档站点的事实标准。大多数文档平台（Notion、Docusaurus、MkDocs、GitBook）支持 GFM 或其超集。
Frontmatter 是向 Markdown 文件添加结构化元数据的常见惯例。文件顶部由 --- 行分隔的 YAML 块可以包含标题、日期、作者和标签，供静态站点生成器（Astro、Hugo、Jekyll、Next.js）用于构建导航和页面布局。
在实践中，"Markdown" 几乎总是指 CommonMark 或 GFM。原始 Markdown 规范留下了许多未定义的边缘情况，CommonMark 用严格的规范解决了这些歧义。GFM 在 CommonMark 基础上扩展了表格、任务列表、删除线和自动链接 URL。评估 Markdown 解析器或渲染器时，检查其 CommonMark 合规性是判断其处理边缘情况能力的可靠指标。
GFM 中的表格使用管道符（|）分隔列，使用连字符（-）作为表头分隔行。列对齐通过分隔行中的冒号控制：:--- 表示左对齐，:---: 表示居中，---: 表示右对齐。表格是 GFM 扩展，不是原始 Markdown 语法的一部分。Frontmatter 由文件最开头的 --- 行分隔，是一个 YAML 元数据块，供静态站点生成器用于页面元数据如标题、日期、布局和标签。GitHub 将 Frontmatter 渲染为文件顶部的表格，但并非所有渲染器都处理它。
围栏代码块使用三个反引号，在开头反引号后跟可选的语言标识符——例如，三个反引号后跟 "javascript" 开始一个带语法高亮的 JavaScript 块。可用的语言标识符取决于渲染平台。缩进四个空格也能创建代码块，但无法指定语言进行高亮显示。