Agent_study/mkdocs.yml at main · Dajucoder/Agent_study · 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
# mkdocs 配置：把 docs/ 渲染为静态站点
# 文档：https://www.mkdocs.org/
# 本地预览：pip install mkdocs mkdocs-material && mkdocs serve
# 部署：推送 tag 后由 .github/workflows/mkdocs.yml 自动构建到 gh-pages

site_name: LangChain 学习项目
site_description: 系统学习 LangChain 框架的实战型项目
site_url: https://dajucoder.github.io/Agent_study/
repo_url: https://github.com/Dajucoder/Agent_study
repo_name: Dajucoder/Agent_study
edit_uri: edit/main/docs/

# 站点额外信息
extra:
  version:
    provider: mike        # 多版本支持（与 mike 插件配合：mike deploy --push --update-docs v0.4）
    default: stable
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Dajucoder/Agent_study
      name: GitHub Repository
    - icon: fontawesome/brands/python
      link: https://python.langchain.com
      name: LangChain Python

docs_dir: docs
site_dir: site

# docs/ 下不渲染为页面的辅助文件
# PROJECT_STRUCTURE 是项目结构说明，单独通过 GitHub 仓库查看
# 注意：*.en.md 不再排除——改由 i18n 插件处理为 /en/ 子站点
exclude_docs: |
  PROJECT_STRUCTURE.md

theme:
  name: material
  language: zh
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.tabs.link
    - content.code.annotate
    - content.action.edit  # 顶部 "Edit this page" 按钮（指向 edit_uri）
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: 切换到深色模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: 切换到浅色模式
  icon:
    repo: fontawesome/brands/github

# Markdown 扩展
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.tilde
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.arithmatex

# 站点导航
# 说明：
#   - 教程 01→06 连续排列，Material 会据此自动生成每页底部的"上一页 / 下一页"。
#   - PROJECT_STRUCTURE.md 已被 exclude_docs 排除出构建，故此处指向 GitHub 源码，避免 404。
#   - 所有 .en.md 由 exclude_docs 排除，语言切换通过各文档顶部导航条完成。
nav:
  - 首页: index.md
  - 快速上手:
      - 环境搭建: ENV_SETUP.md
      - 学习路线: LEARNING_GUIDE.md
      - 目录结构: https://github.com/Dajucoder/Agent_study/blob/main/docs/PROJECT_STRUCTURE.md
  - 教程:
      - 01 模型与提示词: 01-models-and-prompts.md
      - 02 链（LCEL）: 02-chains.md
      - 03 记忆: 03-memory.md
      - 04 检索与 RAG: 04-retrieval-and-rag.md
      - 05 代理: 05-agents.md
      - 06 服务化与部署: 06-langserve-and-deployment.md
  - 进阶:
      - 架构总览: ARCHITECTURE.md
      - 成本与限制: COST_AND_LIMITS.md
      - 可观测性: OBSERVABILITY.md
      - 常见问题: TROUBLESHOOTING.md
  - 参考:
      - 术语表: GLOSSARY.md
      - 参考资料: REFERENCES.md
  - 前端:
      - 在线学习平台: WEB_FRONTEND.md

# 插件
plugins:
  # mkdocs-static-i18n：把 docs/*.md（默认 zh）与 docs/*.en.md（en）配对，
  # 自动生成 /en/ 子站点 + 语言切换器。suffix 模式即"文件名.en.md"约定，
  # 与本项目既有英文文档命名完全一致，无需移动文件。
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      languages:
        - locale: zh
          default: true
          name: 中文
        - locale: en
          name: English
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
      lang:
        - en
        - zh

# 版权信息
copyright: Copyright &copy; 2026 Dajucoder · <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="noopener">CC BY 4.0</a> for documentation