Markdown 常见格式示例文章
本文以一篇常规文章的结构,展示 Markdown 中常见的排版格式,包括标题、段落、强调、列表、引用、链接、图片、代码、表格和脚注等。
一、什么是 Markdown?
Markdown 是一种轻量级标记语言。它允许用户使用简单的符号编写结构清晰的文本,并将其转换为 HTML、PDF 或其他文档格式。 与传统的富文本编辑器相比,Markdown 具有以下特点:
- 语法简单,容易学习
- 纯文本格式,便于版本管理
- 可在不同平台之间迁移
- 适合编写文档、博客、笔记和项目说明
二、文字格式
Markdown 支持多种文字强调方式。
普通文字保持原样。
这是粗体文字。
这是斜体文字。
这是粗斜体文字。
这是删除线文字。
这是一个包含行内代码的句子。
在部分 Markdown 编辑器中,还可以使用 HTML 实现其他效果,例如:
这是带下划线的文字。
H2O 表示水,210 等于 1024。
如果需要显示 Markdown 特殊符号,可以使用反斜杠进行转义:
*这段文字不会显示为斜体*
三、不同级别的标题
Markdown 一般支持六级标题:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
实际写作中,建议从一级标题开始,并按照文章层级依次使用标题,避免跳级。
四、引用内容
引用适合用于展示他人的观点、书籍内容或需要特别强调的信息。
写作不是把文字堆积起来,而是将思想组织成清晰的结构。 引用还可以包含多个段落: Markdown 的价值不只在于语法简单。 它还能够帮助作者专注于内容本身。 引用可以嵌套: 第一层引用 > 第二层引用 > 第三层引用
五、列表
5.1 无序列表
无序列表可以使用减号、加号或星号:
- 第一项内容
- 第二项内容
- 第三项内容 嵌套列表需要缩进:
- 前端开发
- HTML
- CSS
- JavaScript
- 后端开发
- Python
- Java
- Go
5.2 有序列表
- 确定文章主题
- 整理文章结构
- 编写正文内容
- 检查并修改
- 发布文章 嵌套有序列表:
- 准备阶段
- 收集资料
- 明确目标
- 写作阶段
- 编写初稿
- 调整结构
- 完成阶段
- 校对内容
- 导出文档
5.3 任务列表
任务列表常用于项目计划和待办事项:
- 确定文章标题
- 完成文章大纲
- 补充示例图片
- 检查链接是否有效
- 发布最终版本
六、链接
这是一个普通链接:Markdown 官方语法说明 这是一个带提示文字的链接: 访问示例网站 也可以直接显示网址: https://example.com 或者使用引用式链接,让正文更加整洁: 你可以访问示例网站查看更多内容。 文章内部还可以使用锚点链接: 返回文章顶部
七、图片
图片语法与链接类似,只是在前面增加一个感叹号:
也可以使用引用式图片:
图片能否正常显示,取决于图片地址是否有效以及当前编辑器是否允许加载外部资源。
八、代码
8.1 行内代码
可以使用反引号标记变量名、命令或文件名,例如:
请运行 npm install 安装依赖,然后打开 package.json 文件。
8.2 多行代码块
使用三个反引号创建代码块,并在开头指定编程语言。
def greet(name: str) -> str:
"""返回一条问候语。"""
return f"你好,{name}!"
print(greet("Markdown"))
JavaScript 示例:
const users = ["张三", "李四", "王五"];
users.forEach((user, index) => {
console.log(`${index + 1}. ${user}`);
});
Shell 命令示例:
git add .
git commit -m "docs: 添加 Markdown 示例"
git push origin main
8.3 缩进代码块
将内容缩进四个空格,也可以创建代码块:
function add(a, b) {
return a + b;
}
九、表格
表格适合展示结构化数据:
| 姓名 | 职位 | 工作年限 | 状态 |
|---|---|---|---|
| 张三 | 产品经理 | 5 年 | 在职 |
| 李四 | 前端工程师 | 3 年 | 在职 |
| 王五 | 视觉设计师 | 4 年 | 休假 |
可以通过冒号控制对齐方式:
| 左对齐 | 居中对齐 | 右对齐 |
|---|---|---|
| 内容 A | 内容 B | 100 |
| 内容 C | 内容 D | 200 |
表格单元格中也可以使用部分 Markdown 格式:
| 类型 | 示例 |
|---|---|
| 粗体 | 重要内容 |
| 斜体 | 补充说明 |
| 代码 | const value = 1 |
| 链接 | 示例网站 |
十、分隔线
可以使用三个或更多减号、星号或下划线创建分隔线。
为了保持文档风格统一,一篇文章中通常只选择其中一种写法。
十一、脚注
脚注适合补充来源、解释或延伸信息。
Markdown 是一种轻量级标记语言。[^1]
不同平台对扩展语法的支持可能有所不同。[^platform]
[^1]: Markdown 最初由 John Gruber 与 Aaron Swartz 共同设计。
[^platform]: 例如 GitHub Flavored Markdown 支持表格、任务列表和删除线等扩展格式。
十二、折叠内容
部分支持 HTML 的 Markdown 编辑器允许使用折叠区域:
<details>
<summary>点击查看详细内容</summary>
这里是默认隐藏的内容。
- 可以包含列表
- 可以包含段落
- 也可以包含代码
{
"name": "Markdown 示例",
"type": "document"
}
</details>
十三、提示信息
Markdown 本身没有统一的提示框语法,但部分平台支持特殊引用格式。
[!NOTE]
这是补充说明,用于提供额外信息。 [!TIP]
这是一个实用建议。 [!IMPORTANT]
这是需要重点关注的内容。 [!WARNING]
这是警告信息。 [!CAUTION]
这是风险提示。 如果当前平台不支持这些扩展语法,它们通常会显示为普通引用。
十四、数学公式
部分 Markdown 编辑器支持 LaTeX 数学公式。
行内公式示例:
质能方程为 $E = mc^2$。
独立公式示例:
$$
f(x) = ax^2 + bx + c
$$
求和公式:
$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$
数学公式不是基础 Markdown 标准的一部分,需要编辑器支持 MathJax、KaTeX 或类似工具。
十五、综合示例
项目更新报告
截至本周,项目整体完成度约为 75%,核心开发工作已经基本完成。 当前进度如下:
- 需求分析
- 完成用户调研
- 确认功能范围
- 产品设计
- 完成交互原型
- 完成视觉设计
- 技术开发
- 完成后端接口
- 完成前端联调
- 测试发布
- 执行完整测试
- 部署正式环境 关键数据如下:
| 指标 | 当前值 | 目标值 | 完成情况 |
|---|---|---|---|
| 已完成功能 | 18 | 24 | 75% |
| 已修复问题 | 42 | 50 | 84% |
| 自动化测试覆盖率 | 68% | 80% | 进行中 |
目前最重要的任务是完成前端与后端的接口联调。
[!WARNING]
如果接口联调未能按计划完成,测试阶段可能需要顺延。 相关代码位于src/api/目录,可运行以下命令启动项目:
npm install
npm run dev
更多信息请查看项目文档。
十六、总结
Markdown 的核心优势是使用简单的纯文本语法表达清晰的文档结构。日常写作通常只需要掌握以下内容:
- 标题和段落
- 粗体与斜体
- 有序列表和无序列表
- 链接与图片
- 引用和代码块
- 表格与分隔线 其他格式,例如任务列表、脚注、数学公式、提示框和折叠区域,属于扩展功能,实际效果取决于所使用的平台。
