本文目录
什么是 Markdown?
Markdown 是一种轻量级标记语言,由 John Gruber 于 2004 年创建。它使用基于标点符号的简单语法为纯文本添加格式——用 # 表示标题,用 ** 表示加粗,用 [text](url) 表示链接——并渲染为格式化的 HTML。它的简洁性使其成为开发者文档的通用标准。
Markdown 无处不在:GitHub README 文件、Stack Overflow 答案、Slack 消息、Notion 页面、文档站点和博客平台。大多数开发者每天都在书写 Markdown,甚至不假思索。
Markdown 预览的工作原理
CheckTown 的 Markdown 预览会在你输入时将 Markdown 实时渲染为 HTML。
- 遵循 CommonMark——按照 CommonMark 规范渲染标准 Markdown
- GFM 扩展——支持 GitHub 风格的 Markdown,包括表格、任务列表和删除线
- 语法高亮——代码块会针对常见编程语言进行高亮显示
免费试用 —— 无需注册
预览 Markdown →何时使用 Markdown 预览
对于任何需要在发布前验证渲染效果的写作工作流,Markdown 预览都非常有用。
- README 文件——在推送到 GitHub 之前起草并预览 README.md 文件
- 文档——在发布到文档站点之前编写并预览技术文档
- 博客文章——用 Markdown 撰写博客文章并预览格式化后的输出
常见问题
各种 Markdown 变体之间有什么区别?
最初的 Markdown 规范留下了许多未定义的边界情况,导致出现了多种互不兼容的实现。CommonMark 是一套标准化规范,消除了这些歧义。GitHub 风格的 Markdown(GFM)在 CommonMark 的基础上扩展了表格、任务列表和自动链接。大多数平台采用 CommonMark 或 GFM。
Markdown 能包含原始 HTML 吗?
可以,大多数 Markdown 处理器允许在 Markdown 文档中直接嵌入原始 HTML 标签。这对于 Markdown 语法不支持的高级格式化很有用。不过,出于安全考虑,许多平台会对 HTML 进行清理,因此在用户生成内容的场景中,原始 HTML 可能会被剥除。
如何在 Markdown 中添加表格?
表格使用竖线字符和连字符:第一行为 | 表头 1 | 表头 2 |,第二行为分隔行 | --- | --- |,随后是数据行。列的对齐方式由分隔行中冒号的位置控制::--- 表示左对齐,:---: 表示居中,---: 表示右对齐。