openagent-python-sdk/mkdocs.yml at main · MaxQian888/openagent-python-sdk · 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
site_name: OpenAgents SDK
site_description: Config-as-code single-agent runtime kernel for Python
repo_url: https://github.com/openagentsinc/openagent-python-sdk
repo_name: openagent-python-sdk
docs_dir: docs

exclude_docs: |
  plans/
  research/
  superpowers/
  README.md
  requirements.txt

theme:
  name: material
  language: zh
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: 切换到深色模式 / Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: 切换到浅色模式 / Switch to light mode

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: zh
          name: 中文
          default: true
          build: true
        - locale: en
          name: English
          build: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/openagentsinc/openagent-python-sdk

nav:
  - 首页: index.md
  - 入门:
      - 开发者指南: getting-started/developer-guide.md
      - 仓库结构: getting-started/repository-layout.md
      - 示例: getting-started/examples.md
  - 架构:
      - Seam 与扩展点: architecture/seams-and-extension-points.md
  - 配置:
      - 配置参考: configuration/configuration.md
      - 事件分类: configuration/event-taxonomy.md
  - 插件开发:
      - 插件开发指南: plugins/plugin-development.md
  - API 参考:
      - API 参考: reference/api-reference.md
      - 内置工具: reference/builtin-tools.md
      - 流式 API: reference/stream-api.md
      - 错误参考: reference/errors.md
      - 可观测性与日志: reference/observability.md
  - CLI:
      - 内置 CLI: cli/cli.md
      - CLI 命令参考: cli/cli-reference.md
  - 示例详解:
      - Multi-Agent Support: guides/multi-agent-support-example.md
      - PPTX Agent CLI: guides/pptx-agent-cli.md
  - Skills:
      - OpenAgent Agent Builder: skills/openagent-agent-builder.md
  - 迁移:
      - 0.2 → 0.3: migration/migration-0.2-to-0.3.md
      - 0.3 → 0.4: migration/migration-0.3-to-0.4.md