Documentation
README
Wiki Diagram — Mermaid 可视化
用 Mermaid 给概念页配图。Obsidian 原生渲染 ```mermaid 代码块,无需安装插件。
何时配图 When to Diagram
只在"文字描述比图更难懂"时配图,不要每页都加。适合配图的情况:
- 多步骤流程/算法 → flowchart
- 协议交互/攻击步骤,含时序(适合 COMP4337) → sequenceDiagram
- 系统架构/模型结构,含组件关系 → flowchart
- 概念分类/知识地图 → mindmap
- 状态转换/生命周期 → stateDiagram-v2
- 概念间关系网(跨课程连接) → graph
不适合配图:单一定义、纯数学公式推导、线性叙述无分支无关系的内容。
图表类型映射 Diagram Type Mapping
| 内容类型 | Mermaid 类型 |
|---|---|
| 算法步骤/数据处理流程 | flowchart TD |
| 协议/攻击交互序列 | sequenceDiagram |
| 模型架构/系统组件 | flowchart LR |
| 概念分类/知识地图 | mindmap |
| 状态机/生命周期 | stateDiagram-v2 |
| 概念间关系网 | graph TD |
放置位置 Placement
在概念页的 直觉 Intuition 或 详细解释 Detailed 章节之后,新增 ## 图解 Diagram 小节。局部插入,不重写全页。
This is the opening of the README. Read the full README on GitHub.