mkdocs_en.yml

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/en
use_directory_urls: true
# Copyright
copyright: Copyright © 2025 xLLM Team
# docs_dir: docs/en
# Configuration
theme:
  name: material
  language: en
  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: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        # icon: material/toggle-switch
        icon: material/eye
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        # icon: material/toggle-switch-off
        icon: material/eye-outline
        name: Switch to system preference
    # 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:
  # - 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/en/
  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:
  - Home: index.md
  - User Guide:
    - getting_started/quick_start.md
    - supported_models.md
    - getting_started/launch_xllm.md
    - getting_started/disagg_pd.md
    - getting_started/multi_machine.md
    - Basic Usage:
      - getting_started/online_service.md
      - getting_started/offline_service.md
  - Features:
    - Overview:
      - features/overview.md
    - Feature List:
      - Runtime:
        - features/async_schedule.md
        - features/multi_streams.md
      - Scheduler:
        - features/continuous_scheduler.md
        - features/chunked_scheduler.md
        - features/zero_evict_scheduler.md
      - Distributed:
        - features/disagg_pd.md
      - Operators:
        - features/groupgemm.md
        - features/ppmatmul.md
        - features/topk_topP.md
      - Memory Management:
        - features/prefix_cache.md
        - features/global_kvcache.md
        - features/xtensor_memory.md
      - Multimodal:
        - features/multimodal.md
      - MoE Optimization:
        - features/moe_params.md
        - features/eplb.md
      - Advanced Guides:
        - Speculative Inference: features/mtp.md
        - GraphMode: features/graph_mode.md
  - CLI Reference:
    - cli_reference.md