Hello-AI/mkdocs.yml at main · ArchiLantern/Hello-AI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
site_name: Hello-AI
site_url: https://unclecheng-li.github.io/Hello-AI/
site_author: Hello-AI Team
site_description: 面向中文学习者的 AI / LLM 学习入口平台

repo_name: Hello-AI
repo_url: https://github.com/Unclecheng-li/Hello-AI
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2026 Hello-AI Team

theme:
  name: material
  language: zh
  custom_dir: overrides
  features:
    - content.action.edit
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: 切换到深色模式
    - scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/weather-night
        name: 切换到浅色模式
  font:
    text: Noto Sans SC
    code: Fira Code
  icon:
    repo: fontawesome/brands/github
  logo: assets/images/logo.svg
  favicon: assets/images/favicon.svg

plugins:
  - search
  - mermaid-to-svg:
      output_dir: assets/mermaid
      theme: default
      renderer: mmdc
      error_on_fail: true
      cleanup_generated_images: false
      mermaid_config:
        htmlLabels: false
        flowchart:
          htmlLabels: false
        class:
          htmlLabels: false
  - material/tags:
      tags_allowed:
        - AI 基础
        - Prompt
        - Tools
        - RAG
        - Agent
        - Build
        - Eval
        - Safety
        - Lab
        - Resources

extra:
  generator: false
  analytics:
    feedback:
      title: 这页有帮助吗？
      ratings:
        - icon: material/emoticon-happy-outline
          name: 有帮助
          data: helpful
          note: 感谢反馈。你也可以通过页面下方的共建入口继续补充内容。
        - icon: material/emoticon-sad-outline
          name: 需要改进
          data: needs-improvement
          note: 感谢反馈。欢迎通过页面下方的勘误或建议入口提出修改建议。

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - 前言:
      - 前言总览: preface/index.md
      - 为什么学 AI: preface/why.md
      - 学习路线: preface/roadmap.md
      - 常见顾虑: preface/faq.md
  - AI 基础:
      - 基础总览: basics/index.md
      - 什么是 AI: basics/what-is-ai.md
      - 机器学习: basics/machine-learning.md
      - 深度学习: basics/deep-learning.md
      - 什么是 LLM: basics/what-is-llm.md
      - 多模态 AI：文字、图片、语音和视频: basics/multimodal-ai.md
      - 模型、数据、训练与推理: basics/model-data-training.md
      - Token、Embedding 与上下文窗口: basics/token-embedding-context.md
      - Prompt、上下文和记忆: basics/prompt-context-memory.md
      - 温度与采样参数: basics/temperature-sampling.md
      - 为什么模型会胡说: basics/hallucination.md
  - Prompt:
      - Prompt 总览: prompt/index.md
      - Prompt 基础: prompt/prompt-basic.md
      - 角色、任务、约束与输出格式: prompt/structure.md
      - Prompt 模板: prompt/templates.md
      - 让模型稳定输出: prompt/stable-output.md
      - 总结、改写、分类与抽取: prompt/tasks.md
      - Prompt 常见失败案例: prompt/failure-cases.md
  - AI 工具使用:
      - 工具总览: tools/index.md
      - Chat 类产品怎么用: tools/chat-products.md
      - 如何选择模型: tools/model-selection.md
      - API 入门: tools/api.md
      - 函数调用与工具调用: tools/tool-calling.md
      - 本地与在线模型的差异: tools/local-vs-online.md
      - Chat、Copilot、Agent 与 Workflow: tools/workflow.md
  - RAG:
      - RAG 总览: rag/index.md
      - 为什么需要 RAG: rag/why-rag.md
      - 文档切分: rag/chunking.md
      - 向量化: rag/vectorization.md
      - 检索: rag/retrieval.md
      - 重排: rag/rerank.md
      - 生成: rag/generation.md
      - RAG 常见问题: rag/troubleshooting.md
  - Agent智能体:
      - Agent 总览: agent/index.md
      - Agent 和工作流的区别: agent/workflow-vs-agent.md
      - 工具调用: agent/tool-use.md
      - 任务拆解: agent/task-planning.md
      - 反思与循环: agent/reflection-loop.md
      - Agent 常见失败模式: agent/failure-patterns.md
  - AI Build 实战:
      - Build 总览: build/index.md
      - API 接入: build/api-integration.md
      - 最小 AI 应用: build/simple-app.md
      - 本地模型: build/local-models.md
      - 部署入门: build/deployment.md
      - Docker 基础: build/docker.md
  - AI Evals:
      - Eval 总览: eval/index.md
      - 主观与客观指标: eval/metrics.md
      - 幻觉评测: eval/hallucination.md
      - 输出质量判断: eval/quality.md
      - 简单评测: eval/simple-eval.md
  - AI与大模型安全:
      - Safety 总览: safety/index.md
      - 数据泄露: safety/data-leakage.md
      - 提示注入: safety/prompt-injection.md
      - 越权调用: safety/over-permission.md
      - 使用边界与合规提示: safety/compliance.md
  - 实验:
      - Lab 总览: lab/index.md
      - Prompt 改写: lab/prompt-rewrite.md
      - RAG 基础: lab/rag-basics.md
      - Agent 拆解: lab/agent-basics.md
  - 相关资源:
      - 资源总览: resources/index.md
      - 模型平台: resources/models.md
      - API 平台: resources/apis.md
      - RAG 框架: resources/rag-frameworks.md
      - Agent 框架: resources/agent-frameworks.md
      - 评测工具: resources/eval-tools.md
      - 书单与文章: resources/books-and-articles.md
      - 标签索引: tags.md

watch:
  - docs
  - overrides