本文档展示了 Markdown 的各种常用语法和格式,既作为语法参考,也展示极简主题的渲染效果。
标题
Markdown 支持 6 级标题:
|
|
注意:标题会自动生成锚点,可以通过 [链接](#标题) 跳转。
段落与换行
段落
段落之间用空行分隔:
|
|
换行
行末加两个空格或使用 <br>:
|
|
文本样式
强调
|
|
效果:
- 粗体文本
- 斜体文本
- 粗斜体
删除线
标记
|
|
效果:
==高亮文本==
列表
无序列表
|
|
效果:
- 项目 1
- 项目 2
- 子项目 2.1
- 子项目 2.2
- 项目 3
有序列表
|
|
效果:
- 第一项
- 第二项
- 子项 2.1
- 子项 2.2
- 第三项
任务列表
|
|
效果:
- 已完成任务
- 未完成任务
- 待办事项
链接与图片
链接
|
|
效果:
图片
|
|
效果:
![]()
引用
基本引用
|
|
效果:
这是一段引用文本。 可以包含多行内容。
嵌套引用
|
|
效果:
第一层引用
第二层引用
引用中包含其他元素
|
|
效果:
标题
- 列表项 1
- 列表项 2
代码
代码
行内代码
|
|
效果:
这是一段包含 行内代码 的文本。
代码块
使用三个反引号:
|
|
效果:
|
|
支持的语言
主题支持数百种语言的高亮:
| 语言 | 标识符 |
|---|---|
| JavaScript | javascript, js |
| Python | python, py |
| Go | go |
| Rust | rust |
| Java | java |
| C/C++ | c, cpp |
| HTML | html |
| CSS | css |
| YAML | yaml, yml |
| JSON | json |
| Shell | bash, sh, shell |
| SQL | sql |
表格
基本表格
|
|
效果:
| 列1 | 列2 | 列3 |
|---|---|---|
| 数据1 | 数据2 | 数据3 |
| 数据4 | 数据5 | 数据6 |
对齐方式
|
|
效果:
| 左对齐 | 居中 | 右对齐 |
|---|---|---|
| 内容 | 内容 | 内容 |
表格内使用格式
|
|
效果:
| 功能 | 状态 | 说明 |
|---|---|---|
| 粗体 | ✅ | 支持 |
| 斜体 | ✅ | 支持 |
代码 |
✅ | 支持 |
| 链接 | ✅ | 支持 |
分割线
|
|
效果:
脚注
|
|
效果:
这是一个脚注示例1。
数学公式
行内公式
|
|
效果:
质能方程 (E = mc^2) 是物理学基础。
块级公式
|
|
效果:
[ \frac{\partial f}{\partial x} = \lim_{h \to 0} \frac{f(x+h) - f(x)}{h} ]
HTML 标签
Markdown 支持内嵌 HTML:
|
|
效果:
这是一个自定义 HTML 区块
按下 Ctrl + C 复制
转义字符
使用反斜杠转义特殊字符:
|
|
效果:
* 不是斜体 * # 不是标题 [ 不是链接
定义列表
|
|
效果:
- 术语 1
- 定义 1
- 术语 2
- 定义 2a
- 定义 2b
缩写
|
|
效果:
*[HTML]: Hyper Text Markup Language *[CSS]: Cascading Style Sheets
HTML 和 CSS 是前端基础。
组合示例
技术文档风格
|
|
2. 配置环境
创建配置文件:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
apiUrl |
string | ✅ | API 地址 |
timeout |
number | ❌ | 超时时间(毫秒) |
注意:确保 Node.js 版本 >= 16
3. 启动服务
|
|
访问 http://localhost:3000 查看效果。
**效果:**
## 安装步骤
### 1. 下载依赖
运行以下命令:
```bash
npm install
2. 配置环境
创建配置文件:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
apiUrl |
string | ✅ | API 地址 |
timeout |
number | ❌ | 超时时间(毫秒) |
注意:确保 Node.js 版本 >= 16
3. 启动服务
|
|
访问 http://localhost:3000 查看效果。
相关文档
- 🔧 查看 短代码手册 了解高级内容
- ⚙️ 了解 Front Matter 配置
- 📖 学习 快速入门
掌握这些 Markdown 语法,让你的博客文章更专业、更易读!
-
这是脚注的内容,会显示在页面底部。 ↩︎