📋 Markdown 速查表
一页版,忘了就翻这里。建议收藏(Ctrl+D)或打印出来。
基础语法
| 效果 |
写法 |
| 一级标题 |
# 标题 |
| 二级标题 |
## 标题 |
| 三级标题 |
### 标题 |
| 粗体 |
**粗体** |
| 斜体 |
*斜体* |
| 粗斜体 |
***文字*** |
| 删除线 |
~~删除~~ |
| 高亮 |
==高亮==(部分平台) |
| 行内代码 |
`代码` |
| 换行(紧贴) |
文字<br> |
| 新段落 |
中间空一行 |
| 分隔线 |
---(前后空行) |
| 转义(显示符号本身) |
\* \# \_ \` |
列表
| 效果 |
写法 |
| 无序列表 |
- 项目 |
| 有序列表 |
1. 项目 |
| 嵌套(子项) |
缩进 2 空格:- 子项 |
| 任务-未完成 |
- [ ] 待办 |
| 任务-已完成 |
- [x] 已完成 |
链接与图片
| 效果 |
写法 |
| 链接 |
[文字](https://地址) |
| 链接带提示 |
[文字](地址 "悬停提示") |
| 自动链接 |
<https://地址> |
| 引用式链接 |
[文字][1] + 文末 [1]: 地址 |
| 图片 |
 |
| 可点击图片 |
[](大图.png) |
| 图片调宽(HTML) |
<img src="x.png" width="600"> |
| 页内跳转 |
[跳到某节](#标题) |
引用与代码
| 效果 |
写法 |
| 引用 |
> 引用内容 |
| 引用嵌套 |
> > 二级引用 |
| 行内代码 |
`code` |
| 代码块 |
```text ... ``` |
| 带高亮代码块 |
```java ... ``` |
| 代码块里再放代码块 |
外层用 4 个反引号 |
表格
| 效果 |
写法 |
| 基本表格 |
看下面完整例子 |
| 左对齐 |
\| :--- \| |
| 居中 |
\| :---: \| |
| 右对齐 |
\| ---: \| |
| 单元格内换行 |
<br> |
| 单元格里放竖线 |
\\\| |
完整例子:
| 名称 | 版本 | 对齐示例 |
| :--- | :---: | ---: |
| Forge | 47.4.23 | 1234 |
| Java | 17 | 56 |
进阶
| 效果 |
写法 |
| 折叠块 |
<details><summary>标题</summary>内容</details> |
| 脚注 |
文字[^1] + [^1]: 说明 |
| Emoji |
直接贴 😀 或 :smile: |
| 定义列表 |
词条 换行 : 解释 |
| 行内公式 |
$E=mc^2$ |
| 独立公式 |
$$...$$ |
| 流程图 |
```mermaid ... ``` |
| 内嵌 HTML |
直接写 <div>...</div> |
| 目录 |
[TOC](看平台) |
MkDocs Material 专属
| 效果 |
写法 |
| 提示框 |
!!! note "标题" + 缩进 4 空格内容 |
| 警告框 |
!!! warning "标题" |
| 可折叠 |
??? tip "标题" |
| 默认展开折叠 |
???+ tip "标题" |
| 内容分页签 |
=== "标签一" + 缩进内容 |
| 给图片加宽 |
{ width="500" } |
| 代码块标题 |
```java title="Main.java" |
常用 Emoji
| 含义 |
Emoji |
含义 |
Emoji |
| 完成 |
✅ |
错误 |
❌ |
| 警告 |
⚠️ |
提示 |
💡 |
| 禁止 |
🚫 |
重要 |
❗ |
| 文档 |
📄 |
链接 |
🔗 |
| 工具 |
🔧 |
代码 |
💻 |
| 火箭 |
🚀 |
星星 |
⭐ |
| 火 |
🔥 |
猫 |
🐱 |
十大坑(背下来)
- 符号后面必加空格:
# 标题、- 列表、> 引用
- 段落之间要空行,单个回车不等于换行
- 别用全角符号:
# - > : 都不认
- 表格必须有分隔行
| --- | --- |
- 代码块必须闭合(首尾各三个反引号)
- 列表嵌套统一缩进 2 空格
- 标题别跳级(
# → ## → ###)
_下划线斜体_ 在英文词中会失效,用 *
- 聊天软件不渲染表格/任务列表/脚注 → 改用列表 + Emoji
- 中英文之间加空格(中文写作规范)
文档骨架模板
# 标题
一句话说明。
## 前置条件
-
## 操作步骤
1.
## 常见问题
| 现象 | 解决 |
| --- | --- |
## 参考
- [名称](地址)
相关链接
🎉 恭喜学完本教程! 现在你已经会写规范好看的 Markdown 了。