Markdown 基础语法教学¶
Markdown 是一种轻量级标记语言,用简单的符号就能写出结构清晰、易读易写的文档。无论是写博客、记笔记,还是写 README,掌握 Markdown 都能让你事半功倍。本文介绍常用语法,并结合 MkDocs 博客中的实际用法举例。
小提示
可怜的三月海吃了太多md+的便利,导致现在语法都不是特别好...
所以让加了个博客帮助大家并非大家学习,会常来看看的👼
1. 标题¶
用 # 表示标题层级,# 数量对应标题级别(1~6 级):
建议:一篇文章通常只有一个 # 一级标题,其余用 ##、### 组织小节。
2. 强调:粗体与斜体¶
| 效果 | 语法 | 示例 |
|---|---|---|
| 粗体 | **文字** 或 __文字__ |
**重要内容** |
| 斜体 | *文字* 或 _文字_ |
*强调一下* |
| 粗斜体 | ***文字*** |
***特别强调*** |
~~文字~~ |
~~已删除~~ |
删除线(strikethrough)属于 GFM 扩展语法,GitHub、MkDocs 等常见渲染器均支持。
示例:
3. 换行¶
Markdown 中,单个换行符通常不会在渲染结果里产生换行,段落会连成一段。若需要强制换行,可用以下方式:
| 方式 | 写法 | 说明 |
|---|---|---|
| 段落换行 | 连续两个空行 | 产生新段落(会有段间距) |
| 行内换行 | 行末两个空格 + 换行 | 产生 <br> 效果,无段间距 |
| 反斜杠换行 | 行末 \ + 换行 |
部分解析器支持(如 MkDocs) |
建议:需要紧凑换行时用「行末两空格」;需要分段时用空行。
4. 列表¶
4.1 无序列表¶
用 -、* 或 + 开头,后面加空格:
4.2 有序列表¶
用数字加 . 开头:
有序列表的数字可以不连续,渲染时会自动按 1、2、3 显示。
5. 链接与图片¶
5.1 链接¶
5.2 图片¶
图片描述在图片无法加载时会显示,也有助于无障碍访问。
6. 代码¶
6.1 行内代码¶
用反引号 ` 包裹:
6.2 代码块¶
用三个反引号包裹,并指定语言以启用高亮:
常用语言标识:python、bash、javascript、yaml、markdown、text 等。
7. 引用块¶
用 > 表示引用,可多层嵌套:
8. 表格¶
用 | 分隔列,- 分隔表头与内容:
:--- 左对齐,:---: 居中,---: 右对齐。
9. 分隔线¶
三个或以上的 -、* 或 _(可混用,中间留空格)会渲染为水平线:
常用于分隔文章大段落。
10. MkDocs 中的扩展语法¶
你的博客使用 MkDocs Material 主题,支持不少扩展语法,写博客时可以直接使用。
10.1 提示块(Admonition)¶
!!! note "小提示"
这是一段提示内容,可以多行书写。
!!! tip "技巧"
使用 `mkdocs serve` 可以实时预览。
!!! warning "注意"
部署前请先在本地确认效果。
常用类型:note、tip、warning、danger、info 等。
提示块内的限制
提示块(admonition)内的部分扩展语法(如 ~~删除线~~)在某些情况下可能无法正确渲染,会被误解析为下标等。若遇此问题,可改用 HTML 标签:<del>文字</del> 实现删除线效果。
10.2 数学公式¶
配合 MathJax,可写 LaTeX 公式。行内公式用 $...$,块级公式用 $$...$$:
10.3 脚注¶
10.4 定义列表¶
11. 转义字符¶
Markdown 中以下字符有特殊含义,若需原样显示,可在前加反斜杠 \:
例如:\* 会显示为 *,而不是斜体标记。
总结¶
本文介绍了 Markdown 的常用语法:
- 标题:
#~###### - 强调:
**粗体**、*斜体*、~~删除线~~ - 换行:空行分段,行末两空格强制换行
- 列表:
-无序、1.有序 - 链接与图片:
[文字](URL)、 - 代码:
`行内`、```代码块 - 引用:
> - 表格:
|与- - 分隔线:
---
在 MkDocs 博客中,你还可以使用 提示块、数学公式、脚注 等扩展语法,让文章更丰富。建议多动手练习,结合 mkdocs serve 实时预览,很快就能熟练运用。