AgentJet/mkdocs.yml at main · modelscope/AgentJet · 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
site_name: AgentJet
site_url: https://modelscope.github.io/AgentJet/
site_description: "A cutting-edge, user-friendly training framework designed to optimize AgentScope agents and workflows, fine-tuning language model weights behind the scenes."
site_author: "Alibaba Tongyi Lab"
repo_url: https://github.com/modelscope/AgentJet
repo_name: modelscope/AgentJet
copyright: "Copyright &copy; 2025 Alibaba Tongyi Lab"

watch:
  - docs/en

theme:
  name: shadcn
  show_stargazers: true
  git_enabled: false
  nav_sort: false
  features:
    - content.code.copy
    - content.code.annotate
  # icon:
  #   admonition:
  #     warning: material/alert

nav:
  - Overview: index.md

  - • Tutorial:
      - Installation: en/installation.md
      - Tune First Agent: en/tune_your_first_agent.md
      - Swarm Training Intro: en/swarm_intro_blog_en.md
      - Agentic Frameworks: en/agent_framework_support.md

  - • Classic Examples:
      - Math Agent: en/example_math_agent.md
      - AppWorld Agent: en/example_app_world.md
      - Werewolves Game: en/example_werewolves.md
      - Learning to Ask: en/example_learning_to_ask.md
      - Frozen Lake: en/example_frozenlake.md
      - Countdown Game: en/example_countdown.md

  - • Swarm Examples:
      - Best Practice: en/swarm_best_practice.md
      - Swarm Vibe Coding: en/swarm_vibe_coding.md

  - • Components:
      - Workflow: en/workflow.md
      - Data Pipeline: en/data_pipeline.md
      - Task Judger: en/task_judger.md

  - • With Frameworks:
      - OpenAI SDK: en/support_oaisdk.md
      - AgentScope: en/support_agentscope.md
      - Langchain: en/support_langchain.md
      - Raw HTTP: en/support_http.md

  - • Deep Dive:
      - Configuration: en/configuration.md
      - Visualization: en/visualization.md
      - Beast Logger: en/beast_logger.md
      - Data Generation: en/data_generation.md
      - Tracing Feedback: en/example_tracing_feedback_loop.md
      - Timeline Processing: en/context_timeline.md
      - Platform Comparison: en/platform_comparison.md

  - • Blogs:
      - Swarm Intro (ZH): en/swarm_intro_blog_zh.md
      - Multi Model Training (EN): en/example_train_multi_model.md
      - Multi Model Training (ZH): en/example_train_multi_model.zh.md
      - Training OpenClaw (EN): en/example_openclaw.md
      - Training OpenClaw (ZH): en/example_openclaw.zh.md
      - Vibe RL Who is Spy (EN): en/example_vibe_rl_who_is_spy.md
      - Vibe RL Who is Spy (ZH): en/example_vibe_rl_who_is_spy.zh.md

plugins:
  - search:
      lang:
        - en
        - zh
      separator: '[\s\-\.\(\)\/]+'
      min_search_length: 2
      prebuild_index: true
      indexing: 'full'
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            show_submodules: true
markdown_extensions:
  - admonition
  - footnotes
  - tables
  - extra
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.progressbar
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - shadcn.extensions.iconify

extra_css:
  - https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600;700&display=swap
  - stylesheets/feature-cards.css
  - stylesheets/tabbed-code.css
  - stylesheets/readability-enhancements.css
  - stylesheets/code-enhancements.css
  - stylesheets/syntax-highlight.css
  - stylesheets/table-enhancements.css
  - stylesheets/jupyter-simple.css
  - stylesheets/nav-scroll-fix.css
  - stylesheets/workflow.css
  - stylesheets/animations.css
  - stylesheets/mermaid.css
  - stylesheets/mkdocstrings.css
  - stylesheets/responsive.css
  - stylesheets/table-word-wrap.css
  - stylesheets/badge-fix.css

extra_javascript:
  - javascripts/tabbed-code.js
  - javascripts/code-copy.js
  - javascripts/search-fix.js
  - javascripts/code-zoom.js
  - javascripts/nav-scroll-fix.js
  - javascripts/animations.js
  - javascripts/responsive.js