Skip to content

AI-edit-skill.md

Latest commit

 

History

History
276 lines (196 loc) · 4.38 KB

AI-edit-skill.md

File metadata and controls

276 lines (196 loc) · 4.38 KB

AI 编辑技能文档

1. 开发环境

启动开发服务器

mkdocs serve

重要提示：开发前需将 mkdocs.yml 中的 plugins 下 git-committers 和 git-revision-date-localized 相关配置注释掉，避免频繁获取版本信息。

配置管理

  • 所有配置集中在 mkdocs.yml
  • 新增页面时，必须同步更新 nav 部分

2. 内容规范

2.1 结构层级

  • ## 一级标题（章节）
  • ### 二级标题（知识点）
  • #### 三级标题（细分子节）

2.2 关键内容标注

  • 加粗：用于关键术语、重要概念
  • $公式$ 或 \[公式\]：数学公式

2.3 学术用语

  • 参考人教版教科书(物理学科参考教科版)
  • 用词准确规范
  • 逻辑结构清晰

3. Markdown Material 专属语法

3.1 提示块 (Admonitions)

!!! note "普通笔记"
    笔记内容

!!! tip "小贴士"
    提示内容

!!! info "信息"
    信息说明

!!! warning "警告"
    风险提醒

!!! question "问题"
    问题内容

可折叠版本：

??? note "默认折叠"
    折叠内容

???+ note "默认展开"
    默认展开内容

3.2 数学公式

行内公式：$E=mc^2$

块级公式：
\[
\sum_{i=1}^n i = \frac{n(n+1)}{2}
\]

3.3 化学公式（mhchem）

使用 \ce{} 渲染化学式、方程式、上下标等：

行内：水的化学式是 H\ce{_2}O

块级：
\[
\ce{2H2 + O2 -> 2H2O}
\]

常用语法：

语法 效果 说明
\ce{H2O} H₂O 下标
\ce{H2O+} H₂O⁺ 上标
\ce{^{224}_{88}Ra} ²²⁴₈₈Ra 上下标
\ce{Na+} Na⁺ 离子
\ce{->} → 反应箭头
\ce{<=>} ⇌ 可逆反应
\ce{250 ^\circ C} 250°C 条件
\ce{A ->[催化剂] B} 箭头上方标注

3.4 化学结构式

对于复杂的化学结构式，建议使用 SVG 图片：

![苯环结构](../images/md/chemistry/benzene.svg){ width=120px }

3.5 表格

| 列1 | 列2 | 列3 |
|------|------|------|
| 内容 | 内容 | 内容 |

3.6 代码块

标题：
```python title="Python 示例"
code

行号+高亮：

let a = 1;
let b = 2;

3.7 任务列表

- [x] 已完成
- [ ] 待办

3.8 键盘按键

++Ctrl+S++
++Command+Enter++

3.9 图片

![描述](url){ align=center }
![描述](url){ width=50% }

3.10 Mermaid 流程图

使用 Mermaid.js 渲染流程图、思维导图等：

配置：已在 mkdocs.yml 中添加 Mermaid CDN 和初始化脚本。

使用方法：使用 HTML 嵌入模式而非代码块模式：

<div class="mermaid">
graph TB
    A[父节点] --> B[子节点1]
    A --> C[子节点2]
    B --> B1[孙节点]
</div>

常用图表类型：

<!-- 流程图：从上到下 -->
<div class="mermaid">
graph TB
    A[开始] --> B[处理]
    B --> C[结束]
</div>
<!-- 流程图：从左到右 -->
<div class="mermaid">
graph LR
    A[输入] --> B[处理] --> C[输出]
</div>
<!-- 思维导图样式 -->
<div class="mermaid">
graph TB
    A[中心主题] --> B[分支1]
    A --> C[分支2]
    A --> D[分支3]
    B --> B1[子主题]
    B --> B2[子主题]
</div>

主题颜色：当前使用 forest 主题（绿色系）。

4. 内容模式

4.1 知识点文档

## 章节标题

### 小节

**概念**
内容...

!!! note "要点"
    要点内容

| 项目 | 说明 |
|------|------|
| 内容 | 说明 |

4.2 比较表格

用于对比多个概念的异同：

!!! note "比较"

    | 特征 | 概念A | 概念B |
    |------|------|------|
    | 特点1 | ... | ... |
    | 特点2 | ... | ... |

4.3 例题与练习

???+ success "例题"
    
    题目...
    
    答案：...

5. 常见操作

5.1 新增页面

  1. 在 docs/ 下创建 .md 文件
  2. 在 mkdocs.yml 的 nav 部分添加入口
  3. 使用 mkdocs serve 预览效果

6. 文件组织

docs/
├── index.md          # 首页
├── [科目]/
│   ├── [科目]-intro.md    # 科目简介
│   ├── notes.md           # 主笔记
│   ├── [年级]/
│   │   ├── U1.md          # 章节内容
│   │   └── ...