mkdocs.yml

site_name: mlxcel
site_description: High-performance LLM/VLM inference engine for Apple Silicon and CUDA GPUs, built with Rust and native MLX C++ bindings.
site_url: https://mlxcel.lablup.ai/en/manual/
repo_name: lablup/mlxcel
repo_url: https://github.com/lablup/mlxcel
edit_uri: edit/main/docs/en/

docs_dir: docs/en
site_dir: site/en

theme:
  name: material
  language: en
  custom_dir: docs/overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - scheme: default
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Ubuntu
    code: Ubuntu Mono
  favicon: shared/images/favicon.png
  logo: shared/images/logo.png

extra_css:
  - shared/stylesheets/extra.css

hooks:
  - docs/hooks/diagram_replacer.py
  - docs/hooks/section_numbering.py
  - docs/hooks/pdf_header.py
  - docs/hooks/pdf_links.py

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()`"/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mermaid2
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
  - macros:
      include_dir: docs/shared/snippets

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: none
  - 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
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: lablup
      repo: mlxcel
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  alternate:
    - name: English
      link: /en/manual/
      lang: en
    - name: 한국어
      link: /ko/manual/
      lang: ko
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lablup/mlxcel

nav:
  - Home: index.md
  - Getting Started:
      - getting-started/index.md
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
  - Concepts:
      - concepts/index.md
      - Architecture Overview: concepts/architecture.md
      - Model Loading Pipeline: concepts/model-loading.md
      - Inference Pipeline: concepts/inference-pipeline.md
      - KV Cache Management: concepts/kv-cache.md
      - Sampling Strategies: concepts/sampling.md
  - User Guide:
      - user-guide/index.md
      - CLI Commands: user-guide/cli.md
      - Server Mode: user-guide/server.md
      - Vision-Language Models: user-guide/vision-language-models.md
      - LoRA Adapters: user-guide/lora.md
      - Speculative Decoding: user-guide/speculative-decoding.md
      - Continuous Batching: user-guide/continuous-batching.md
      - Prompt Cache: prompt_cache.md
      - Language Bias: user-guide/lang-bias.md
  - API Reference:
      - api-reference/index.md
      - REST API: api-reference/rest-api.md
      - Supported Models: api-reference/supported-models.md
  - Distributed Inference:
      - distributed/index.md
      - Overview: distributed/overview.md
      - Tensor Parallelism: distributed/tensor-parallelism.md
      - Pipeline Parallelism: distributed/pipeline-parallelism.md
      - Disaggregated Inference: distributed/disaggregated-inference.md
  - Development:
      - development/index.md
      - Adding New Models: development/adding-models.md
      - mlxcel-core FFI Bridge: development/mlxcel-core.md
      - Testing: development/testing.md