项目背景 (这是标题吗?)
1 表格
Markdown表格使用竖线(|)分隔列,用短横线(-)定义表头分隔行
| 表头1 | 表头2 | 表头3 |
|---|---|---|
| 内容1 | 内容2 | 内容3 |
表格分隔线需要至少3个短横线:
- 正确格式:---、----、-----等
- 错误格式:--(两个短横线)
- 短横线的数量不影响表格的渲染效果
- 短横线数量多是出于编辑体验和视觉美观的考虑
- 三者不能缺:如果省略分隔线,Markdown渲染器会将表格视为普通段落,而不是表格
对齐控制
Markdown支持三种对齐方式,通过在分隔行添加冒号实现:
- 左对齐:
:--- - 居中对齐:
:---: - 右对齐:
---:
| 左对齐 | 居中 | 右对齐 |
|---|---|---|
| 文本 | 100 | 200 |
2 流程图 mermaid
graph TD
A[开始] --> B{是否继续?}
B -->|是| C[执行操作]
C --> D[结束]
B -->|否| D
3 层次定义的最佳实践(黄金法则)
| Markdown 语法 | 文档术语 | 适用场景 |
|---|---|---|
# 标题 |
章 (Chapter) | 书名或核心篇章 |
## 标题 |
节 (Section) | 核心模块、主要议题 |
### 标题 |
小节 (Subsection) | 议题下的细分内容 |
#### 标题 |
条 (Clause) | 具体条款、操作步骤 |
##### 标题 |
目 (Item) | 极细颗粒度的说明 |
法规类型:
| 层级 | 术语 | Markdown 建议 | 说明 | 示例 |
|---|---|---|---|---|
| L1 | 编 (Part) | ## |
最大的逻辑分块。 | 第一编 总则 |
| L2 | 章 (Chapter) | ### |
文档的核心结构单元。 | 第一章 基础权利 |
| L3 | 节 (Section) | #### |
对章的进一步细分。 | 第一节 财产权 |
| L4 | 条 (Article) | ##### 或 粗体 |
法律的核心灵魂,是最常用的引用单位。 | 第十条 资产归属 |
| L5 | 款 (Paragraph) | 正文段落 | 条之下的自然段,不带编号,按顺序数。 | (第十条第二款) |
| L6 | 项 (Sub-item) | 列表 1. |
具体列举的内容,通常用数字括号。 | (一) 现金资产 |
| L7 | 目 (Point) | 缩进列表 | 最后的细分说明。 | 1. 银行存款 |
遵循 “3级原则”
- H1 (#):文档唯一标题(不带数字)。
- H2 (##):一级逻辑,使用
1.,2.。 - H3 (###):二级逻辑,使用
1.1,1.2。 - 正文 (List):再往下的层级,不再建议使用数字标题,而是使用 无序列表 (
*或-),否则会导致文档支离破碎。
一个 Markdown 文件只保留一个 # (H1) 作为总标题。
错误示范:逻辑混乱(多个 #)
# 项目背景 (这是标题吗?)
...文字...
# 架构设计 (这又是标题吗?)
...文字...
# 代码实现 (还是标题?)
规范示范:层次分明
# 智能语音识别系统技术文档 (H1: 全局唯一标题)
---
## 1. 背景介绍 (H2: 章节)
### 1.1 行业现状 (H3: 子点)
### 1.2 核心痛点 (H3: 子点)
---
## 2. 系统架构 (H2: 章节)
### 2.1 硬件层 (H3)
#### 2.1.1 麦克风矩阵 (H4: 最小细分)
### 2.2 算法层 (H3)
完整示例
# 城市交通流预测系统架构 (H1 - 总标题)
> **版本:** v2026.1
> **逻辑:** 1 (模块) -> 1.1 (子组件) -> * (具体细节)
---
## 1. 数据采集层 (H2 - 一级逻辑)
本层负责从多源传感器获取原始数据,并进行初步逻辑清洗。
### 1.1 传感器数据协议 (H3 - 二级逻辑)
目前系统支持以下三种核心协议:
* **MQTT:** 用于实时流处理,延迟控制在 10ms 内。
* **HTTP/2:** 用于批量非实时数据上传。
* **WebSocket:** 用于监控界面的实时心跳。
### 1.2 数据预处理逻辑 (H3)
1. **去噪:** 剔除置信度低于 0.6 的异常信号。
2. **归一化:** 将所有流量数据映射至 $[0, 1]$ 区间。
---
## 2. 模型训练层 (H2)
采用基于 Transformer 的时空预测模型。
### 2.1 特征工程 (H3)
特征提取分为三个关键维度:
1. **时间维度:** 包含小时、工作日/节假日特征。
2. **空间维度:** 包含路网拓扑结构的邻接矩阵。
3. **外部因子:** 实时天气、突发事故。
### 2.2 逻辑评估指标 (H3)
我们使用以下公式计算预测偏差:
$$RMSE = \sqrt{\frac{1}{n}\sum_{i=1}^{n}(y_i - \hat{y}_i)^2}$$
---
## 3. 部署与监控 (H2)
### 3.1 容器化策略 (H3)
* **基础镜像:** Python 3.10-slim。
* **资源配额:** - CPU: 4 Cores (Limit)
- GPU: 1 * NVIDIA A100
---
## 4. 待办事项 (H2)
- [x] 完成路网拓扑结构映射。
- [ ] 优化 1.2 节中的归一化算法(计划 2 月完成)。
4 图片
控制宽度:在图片地址尾部竖线 | 后直接加宽度
5 反引号
5.1 什么时候用反引号 `
它的核心作用是“语义隔离”。通常用于以下场景:
- 代码或指令: 如
git commit。 - 特定变量/参数: 如你文中的
公司、条款。 - 界面 UI 元素: 比如“点击
提交按钮”。 - 强调特定术语的字面量: 当你想表达“这个具体的词本身”而不是它背后的含义时。
对于章节名称或文档模块,标准的排版做法是使用 粗体 (**...**) 或者 引号(“...”)
5.2 代码块里还有代码块
外层反引号数量 > 内层反引号数量
例如:
| 层级 | 写法 |
|---|---|
| 外层 | ```` |
| 内层 | ``` |
| 再内层 | `` |
# 文章完整内容
``
{文章完整内容粘贴处}
``
6 统一使用英文的":"+一个空格
若追求极致 AI 友好,全程用英文 : 也完全可行
若你搭建的是纯技术 / AI 知识库,无对外正式排版需求,直接全程使用英文冒号即可,无需纠结中文排版,AI 的处理效率会达到最高,且编辑器 / 跨工具适配无任何问题。
7 Markdown 工具
7.1 markdownlint
markdownlint 是一款开源的静态分析工具,专门用于检查 Markdown 格式文件的语法、风格和规范问题,核心目标是让 Markdown 文档保持统一、规范的书写格式,避免因个人书写习惯差异导致文档格式混乱。
它并非编辑器,而是 “格式检查器”—— 就像代码领域的 ESLint(检查 JavaScript 代码规范)、Pylint(检查 Python 代码规范)一样,只不过聚焦于 Markdown 文档的格式合规性。
覆盖 Markdown 书写的常见不规范场景,比如:
- 标题层级混乱(比如一级标题后直接跳三级标题);
- 列表符号不统一(混用
-和*作为无序列表项); - 多余的空格 / 空行(比如行尾多余空格、标题前后空行不规范);
- 链接 / 图片格式错误(比如缺少 alt 文本、链接地址格式不合法);
- 标点符号不规范(比如中文语境下使用英文句号)。