什么是 Markdown?轻量标记语言的完整说明
快速解答
Markdown 是一种纯文本标记语言,它使用简单的符号来格式化文本:# 表示标题,** 表示粗体,* 表示斜体,- 表示列表,[text](url) 表示链接。它被设计为可读为纯文本并可转换为 HTML。使用我们免费的 Markdown 到 HTML 转换器在浏览器中呈现 Markdown。
介绍
Markdown 是 John Gruber 在 2004 年创建的一种轻量级标记语言,它使用纯文本格式来生成结构化文档。目标是可读性——Markdown 源文本应该看起来像它所代表的那样,没有 HTML 标签的视觉混乱。 Markdown 是 GitHub 上的 README 文件、文档网站、博客文章、Reddit 和 Stack Overflow 等平台上的评论以及 Obsidian 和 Notion 等笔记应用程序的标准。 Markdown 转换为 HTML 以进行网络发布。
步步
-
学习基本语法
标题:# H1、## H2、### H3。粗体:**文本**。斜体:*文本*。列表: - 项目或 1. 项目。链接:[文本](网址)。图片:。代码:“内联”或“块”。块引用:> 引用。水平规则:---。
-
了解哲学
Markdown 被设计为纯文本可读。源代码应该看起来接近最终渲染的输出 - **粗体**看起来像粗体,#标题看起来像标题。这与 HTML 形成鲜明对比,其中<strong>粗体</strong>和<h1>标题</h1>在视觉上显得混乱。
-
了解变体
原始 Markdown(格鲁伯的规范)是最小的。 CommonMark 是一个标准化、详细说明的版本。 GitHub Flavored Markdown (GFM) 添加了表格、删除线、任务列表和自动链接。 MDX 允许您在 Markdown 中嵌入 React 组件。大多数工具都支持 GFM。
-
将 Markdown 转换为 HTML
Markdown 转换为 HTML 以进行网络发布。 # Hello 变为 <h1>Hello</h1>,**bold** 变为 <strong>bold</strong>。静态站点生成器(Astro、Hugo、Jekyll)在构建时转换 Markdown。使用我们的 Markdown 到 HTML 转换器进行即时转换。
示例
标题和段落
输入: # 标题
一段。
输出: <h1>Title</h1>
<p>A paragraph.</p>
粗体和斜体
输入: **粗体**和*斜体*
输出: <strong>bold</strong> and <em>italic</em>
链接和图片
输入: [text](https://example.com) and 
输出: <a href="https://example.com">text</a> and <img src="image.png" alt="alt">
常见问题
- 换行符——Markdown 中的单个换行符不会在 HTML 中创建换行符。在行尾使用两个空格,或使用两个换行符作为段落分隔符。
- 嵌套列表——缩进很重要。对于嵌套项目,一致使用 2 或 4 个空格;混合它们可能会破坏列表结构。
- 原始 HTML — 大多数 Markdown 解析器都会通过原始 HTML,但有些会对其进行清理。如果直接嵌入 HTML,请检查解析器的行为。
- 风格不同——Original Markdown、CommonMark 和 GFM 有细微的差别。检查您的目标平台支持哪种风格。
提示
- 使用 Markdown 进行写作和文档——它比 HTML 更容易阅读和编写。
- GitHub Flavored Markdown (GFM) 是最常见的变体——它添加了表格、删除线和任务列表。
- 使用 Markdown 编写并在构建博客和文档网站时转换为 HTML。
- 使用我们的 Markdown 到 HTML 转换器在浏览器中立即呈现 Markdown。