recipes/mkdocs.yml at main · SemiAnalysisAI/recipes · 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
site_name: vLLM Recipes
site_url: !ENV READTHEDOCS_CANONICAL_URL
site_description: A collection of recipes and guides for using vLLM with a variety of models.
repo_url: https://github.com/vllm-project/recipes
edit_uri: edit/main/
docs_dir: .
strict: true

# Keep the legacy MkDocs site focused on the hand-written Markdown guides
# under DeepSeek/, Qwen/, etc. Exclude the Next.js app + content YAMLs +
# every vendor/build directory. Uses gitignore-style patterns.
exclude_docs: |
  # Next.js site
  /src/
  /public/
  /.next/
  /out/
  /node_modules/
  /next.config.mjs
  /postcss.config.mjs
  /package.json
  /package-lock.json
  /pnpm-lock.yaml
  /jsconfig.json

  # YAML recipe content + build artefacts
  /models/
  /strategies/
  /scripts/
  /taxonomy.yaml
  /CLAUDE.md

  # Python / uv virtualenv
  /.venv/
  /requirements.txt
  /pyproject.toml
  /uv.lock

  # Editor / agent config
  /.claude/
  /.idea/
  /.vscode/

theme:
  name: material
  custom_dir: overrides
  logo: https://docs.vllm.ai/en/latest/assets/logos/vllm-logo-only-light.ico
  favicon: https://docs.vllm.ai/en/latest/assets/logos/vllm-logo-only-light.ico
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-2
        name: Switch to system preference
  features:
    - content.action.edit
    - content.code.copy
    - content.tabs.link
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow

plugins:
  - search
  - same-dir
  - meta
  - awesome-nav
  - glightbox
  - git-revision-date-localized:
      enable_creation_date: true
      # Don't try to stat git history for untracked vendor/build trees.
      exclude:
        - node_modules/*
        - .venv/*
        - .next/*
        - site/*
        - public/*

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  # For content tabs
  - pymdownx.superfences
  - pymdownx.tabbed:
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
      alternate_style: true
  # For code highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  # For emoji and icons
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  # For in page [TOC] (not sidebar)
  - toc:
      permalink: true
  # For math rendering
  - mdx_math:
      enable_dollar_delimiter: true

extra_javascript:
  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML

use_directory_urls: false