Markdown 基本语法
Markdown 是一种轻量级标记语言,排版语法简洁,让人们更多地关注内容本身而非排版。它使用易读易写的纯文本格式编写文档,可与HTML混编,可导出 HTML、PDF 以及本身的 .md 格式的文件。
设计理念
Markdown 的目标是实现「易读易写」。
可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。
Markdown 语法的首要设计目标是尽可能易读。基于这个目标,Markdown 格式的文档能够以纯文本形式原样发布,而不会看起来像被填满了标签或格式化指令。
—— John Gruber
兼容 HTML
Markdown 语法的目标是:成为一种适用于网络的书写语言。
Markdown 不是想要取代 HTML,甚至也没有要和它相近,它的语法种类很少,只对应 HTML 标记的一小部分。
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown;只要直接加标签就可以了。
例如,在 Markdown 文件里加上一段 HTML 表格:
这是一个普通段落。
<table>
<tr>
<td>Foo</td>
</tr>
</table>
这是另一个普通段落。
特殊字符自动转换
在 HTML 文件中,有两个字符需要特殊处理:<
和 &
。
<
符号用于起始标签&
符号则用于标记 HTML 实体
Markdown 让你可以自然地书写字符,需要转换的由它来处理好了。如果你使用的 &
字符是 HTML 字符实体的一部分,它会保留原状,否则它会被转换成 &
。
基本语法元素
Markdown 基本语法包括以下元素:
块级元素
内联元素
其他
语法示例
下面是一个包含多种基本语法的示例:
# 我的文档
这是一个**粗体文本**和一个*斜体文本*的例子。
## 列表示例
### 购物清单
- 苹果
- 香蕉
- 橙子
### 任务列表
1. 学习 Markdown 基本语法
2. 练习写作
3. 分享给朋友
> 这是一个引用块的例子。Markdown 让写作变得简单而优雅。
这是一个[链接到首页](/zh/)的例子。
代码示例:
你也可以使用行内代码,比如 console.log('Hello World')
。
最佳实践
标题使用
- 每个文档只使用一个一级标题 (
#
) - 保持标题层级的逻辑性,不要跳级
- 在标题前后留空行
列表格式
- 无序列表保持符号一致性(统一使用
-
、*
或+
) - 列表项之间不需要空行,除非包含多个段落
链接和图片
- 为链接提供有意义的文本描述
- 为图片提供替代文本(alt text)
代码展示
- 短代码使用行内代码格式
- 长代码或多行代码使用代码块
- 为代码块指定语言以获得语法高亮
工具支持
几乎所有 Markdown 应用程序都支持这些基本语法元素。不同的 Markdown 处理器之间可能存在细微差异,但基本语法是通用的。
下一步
现在你已经了解了 Markdown 基本语法的概述,可以:
开始学习具体的语法元素: