xllm/mkdocs_zh.yml at main · phantomlei3/xllm · 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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
site_name: xLLM
site_url: !ENV READTHEDOCS_CANONICAL_URL

# Repository
repo_name: jd-opensource/xllm
repo_url: https://github.com/jd-opensource/xllm

edit_uri: edit/main/docs/zh
use_directory_urls: true
# Copyright
copyright: Copyright &copy; 2025 xLLM Team
# docs_dir: docs/zh
# Configuration
theme:
  name: material
  language: zh
  custom_dir: docs/mkdocs/overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.path
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: 切换亮色模式
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        # icon: material/toggle-switch
        icon: material/eye
        name: 切换暗色模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        # icon: material/toggle-switch-off
        icon: material/eye-outline
        name: 切换到系统偏好
    # primary: custom
    # accent: custom
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/logo.png
  logo: assets/logo.png
  icon:
    annotation: material/arrow-right-circle
  # icon:
  #   logo: logo
# Plugins
plugins:
  # - awesome-pages
  # - blog
  # - static-i18n
  - git-revision-date-localized:
      exclude:
        - argparse/*
        - examples/*
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
extra_css:
  - mkdocs/stylesheets/extra.css
# extra_dir: assets
# Hooks
# hooks:
#   - material/overrides/hooks/shortcodes.py
#   - material/overrides/hooks/translations.py

# Additional configuration
extra:
  source:
    path: https://github.com/jd-opensource/xllm/blob/main/docs/zh/

  status:
    new: Recently added
    deprecated: Deprecated
  # analytics:
  #   provider: google
  #   property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jd-opensource/xllm
    - icon: gitcodeai
      link: https://gitcode.com/xLLM-AI/xllm
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/xllm/xllm-ai
    - icon: email-fill
      link: https://github.com/jd-opensource/xllm
    # - icon: fontawesome/brands/python
    #   link: https://pypi.org/project/mkdocs-material/
    # - icon: fontawesome/brands/bluesky
    #   link: https://bsky.app/profile/squidfunk.bsky.social
    # - icon: fontawesome/brands/mastodon
    #   link: https://fosstodon.org/@squidfunk
    # - icon: fontawesome/brands/x-twitter
    #   link: https://x.com/squidfunk

# Extensions
markdown_extensions:
  - tables
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: jd-opensource
      repo: xllm
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed
  # - pymdownx.superfences:
  #     custom_fences:
  #       - name: mermaid
  #         class: mermaid
  #         format: !!python/name:pymdownx.superfences.fence_code_format
  # - pymdownx.tabbed:
  #     alternate_style: true
  #     combine_header_slug: true
  #     slugify: !!python/object/apply:pymdownx.slugs.slugify
  #       kwds:
  #         case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - mdx_math:
      enable_dollar_delimiter: true
extra_javascript:
  - mkdocs/javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js


nav:
  - 主页: index.md
  - 用户指南:
    - getting_started/quick_start.md
    - supported_models.md
    - getting_started/launch_xllm.md
    - getting_started/disagg_pd.md
    - getting_started/multi_machine.md
    - 基本用法:
      - getting_started/online_service.md
      - getting_started/offline_service.md
  - 功能介绍:
    - 概览:
      - features/overview.md
    - 功能列表:
      - 运行时:
        - features/async_schedule.md
        - features/multi_streams.md
      - 调度器:
        - features/continuous_scheduler.md
        - features/chunked_scheduler.md
        - features/zero_evict_scheduler.md
      - 分布式:
        - features/disagg_pd.md
      - 算子:
        - features/groupgemm.md
        - features/ppmatmul.md
        - features/topk_topP.md
      - KV存储管理:
        - features/prefix_cache.md
        - features/global_kvcache.md
        - features/xtensor_memory.md
      - 多模态:
        - features/multimodal.md
      - MoE优化:
        - features/moe_params.md
        - features/eplb.md
      - 进阶指南:
        - 投机推理: features/mtp.md
        - GraphMode: features/graph_mode.md
      - xLLM Service概览: features/xllm_service_overview.md
  - CLI参考:
    - cli_reference.md

# nav:
#   - 主页: index.md
#   - 开始使用: getting_started/
#   - 功能介绍: features/
#   - CLI参考: cli_reference.md
# nav:
#   - 主页: zh/index.md
#   - 开始使用:
#     - zh/getting_started/compile.md
#     - 快速开始:
#       - 在线服务:
#         - zh/getting_started/single_node.md
#         - zh/getting_started/multi_node.md
#         - zh/getting_started/PD_disagg.md
#       - 多模态支持:
#         - zh/getting_started/start_vlm_service.md
#     - zh/getting_started/scripts.md
#   - 功能介绍:
#     - 概览:
#       - zh/features/overview.md
#     - 功能列表:
#       - 运行时:
#         - zh/features/async_schedule.md
#         - zh/features/multi_streams.md
#       - 调度算法:
#         - zh/features/continuous_scheduler.md
#         - zh/features/chunked_scheduler.md
#         - zh/features/zero_evict_scheduler.md
#         - zh/features/prefix_cache.md
#       - 分布式:
#         - zh/features/disagg_pd.md
#       - 算子:
#         - zh/features/groupgemm.md
#         - zh/features/ppmatmul.md
#         - zh/features/topk_topP.md
#       - KV存储管理:
#         - zh/features/global_kvcache.md
#         - zh/features/xtensor_memory.md
#       - 多模态:
#         - zh/features/multimodal.md
#       - MoE优化:
#         - zh/features/moe_params.md
#         - zh/features/eplb.md
#       - 进阶指南:
#         - 投机推理: zh/features/mtp.md
#         - ACLGraph: zh/features/acl_graph.md
#       - xLLM Service概览: zh/features/xllm_service_overview.md
#   - CLI参考:
#     - zh/cli_reference.md