本文涵盖了所有基础 Markdown 语法,帮助你编写丰富、结构清晰的内容。每个功能都附带可用的示例,让你直观地看到渲染效果。
目录
标题
Markdown 支持六个级别的标题,使用 # 符号来定义标题层级。
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
每个标题会自动生成锚点链接,这也是上面目录能够跳转的原理。为了无障碍访问,请勿跳过标题层级——应从 h2 到 h3,而不是从 h2 直接到 h5。
文本格式
Markdown 提供多种内联格式选项:
| 语法 | 效果 |
|---|---|
**粗体文本** | 粗体文本 |
*斜体文本* | 斜体文本 |
~~删除线~~ | |
**_粗斜体_** | 粗斜体 |
`行内代码` | 行内代码 |
<mark>高亮文本</mark> | 高亮文本 |
<sup>上标</sup> | x2 |
<sub>下标</sub> | H2O |
你可以自由组合这些格式:
- 这是 粗体与斜体 的混合使用,出现在一句话中。
- 这段文字有
被删除的部分和 替换内容。 - 在 粗体上下文 中使用
行内代码:config.ts配置文件。
列表
无序列表
使用 -、* 或 + 创建无序列表:
- 第一项
- 第二项
- 第三项
- 嵌套项 A
- 嵌套项 B
- 深层嵌套项
- 另一个深层嵌套项
- 嵌套项 C
- 第四项
有序列表
使用数字加句点创建有序列表:
- 第一步
- 第二步
- 第三步
- 子步骤 3a
- 子步骤 3b
- 子子步骤
- 另一个子子步骤
- 子步骤 3c
- 第四步
混合列表
你可以将有序列表嵌套在无序列表中,反之亦然:
- 项目搭建
- 初始化仓库
- 安装依赖
- 配置环境
- 开发阶段
- 创建组件
- 编写测试
- 代码审查
- 部署上线
- 构建项目
- 运行测试
- 部署到生产环境
包含段落的列表
列表项可以通过缩进包含多个段落:
-
第一项,附带详细描述。
这是第一项下的续接段落。注意空行和缩进的使用方式。
-
第二项。
这里是另一个段落。正确缩进后,列表项可以包含任何块级内容。
链接与图片
内联链接
访问 Astro 官方网站 了解更多关于这个框架的信息。
你也可以添加标题属性:Astro 文档。
引用式链接
为了保持文本整洁,可以使用引用式链接:
阅读 Astro 指南 或查看 Tailwind 文档 了解样式方案。
自动链接
直接粘贴 URL 即可变为可点击的链接:https://github.com
图片
标准图片语法:
带标题的图片:
带链接的图片
引用
简单引用
Markdown 是一种轻量级标记语言,使用纯文本格式语法。 它由 John Gruber 于 2004 年创建。
多段落引用
引用的第一段。
引用的第二段。在段落之间的空行上使用
>以保持在同一个引用块中。
嵌套引用
这是外层引用。
这是嵌套引用,深入一层。
这里嵌套了三层!
回到第一层。
包含其他元素的引用
引用中的标题
- 第一项
- 第二项
引用可以包含 粗体、斜体 和
代码格式,以及列表和其他 Markdown 元素。
分割线
你可以使用三个或更多的连字符、星号或下划线创建分割线:
三种方式渲染效果完全相同。使用它们来对内容进行视觉分隔。
表格
简单表格
| 姓名 | 角色 | 所在地 |
|---|---|---|
| Alice | 前端开发 | 东京 |
| Bob | 后端开发 | 柏林 |
| Carol | DevOps 工程师 | 纽约 |
对齐表格
使用冒号控制列对齐方式:
| 左对齐 | 居中对齐 | 右对齐 |
|---|---|---|
| 内容 | 内容 | 内容 |
| 更多 | 更多 | 更多 |
| 文本 | 文本 | 文本 |
复杂表格
| 功能 | 免费版 | 专业版 | 企业版 |
|---|---|---|---|
| 用户数 | 1 | 10 | 无限制 |
| 存储空间 | 1 GB | 100 GB | 1 TB |
| API 调用 | 1,000次/月 | 100,000次/月 | 无限制 |
| 技术支持 | 社区 | 邮件 | 7×24 电话 |
| SSO 单点登录 | ❌ | ❌ | ✅ |
| 自定义域名 | ❌ | ✅ | ✅ |
| 数据分析 | 基础 | 高级 | 高级 |
带格式的表格
| 方法 | 描述 | 示例 |
|---|---|---|
GET | 获取资源 | fetch('/api/users') |
POST | 创建新资源 | fetch('/api/users', { method: 'POST' }) |
PUT | 更新资源 | fetch('/api/users/1', { method: 'PUT' }) |
DELETE | 删除资源 | fetch('/api/users/1', { method: 'DELETE' }) |
任务列表
任务列表(复选框)非常适合追踪进度:
- 搭建 Astro 项目
- 配置 Tailwind CSS
- 创建博客布局
- 添加搜索功能
- 实现深色模式切换
- 编写文档
嵌套任务列表
- 第一阶段:基础建设
- 项目脚手架
- 设计系统搭建
- 基础组件开发
- 第二阶段:功能开发
- 博客文章渲染
- 标签筛选
- 分页功能
- 第三阶段:打磨优化
- 性能优化
- 无障碍审计
- 跨浏览器测试
脚注
脚注可以添加参考信息而不打乱正文阅读。
Markdown 由 John Gruber1 和 Aaron Swartz2 于 2004 年创建。此后它成为了网络上最流行的标记语言之一3。
最初的 Markdown 规范1有意保持简洁。许多扩展语法如 GitHub Flavored Markdown(GFM)4在原始规范基础上进行了扩展。
Emoji 表情
你可以在 Markdown 中使用 emoji 短代码:
- 🚀 发布日!
- ⭐ 精选内容
- :book: 文档
- 💡 每日技巧
- ⚠️ 重要通知
- ✔️ 任务完成
- ❌ 测试失败
- ❤️ 社区之爱
- 🎉 庆祝时刻
- 🚧 施工中
上下文中的 Emoji
💡 提示: 在技术写作中应适度使用 emoji。它们非常适合状态指示和轻松风格的博客文章。
以下是一个快速项目状态概览:
| 任务 | 状态 |
|---|---|
| 后端 API | ✔️ 已完成 |
| 前端 UI | 🚧 进行中 |
| 文档 | :book: 编写中 |
| 测试 | ❌ 未开始 |
| 部署 | 🚀 就绪 |
总结
本文涵盖了你日常使用的核心 Markdown 语法。Markdown 的简洁性正是它的优势——几个简单的符号就能将纯文本转换为丰富的结构化文档。如需了解数学公式、代码高亮和告警提示等更高级的功能,请参阅 Markdown 扩展功能 一文。
评论区
文明评论,共建和谐社区