lmstack/mkdocs.yml at main · Infinirc/lmstack · 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
site_name: LMStack
site_description: LLM Deployment Management Platform
site_url: https://infinirc.com
repo_url: https://github.com/Infinirc/lmstack
repo_name: lmstack/lmstack

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting_started/index.md
    - Installation: getting_started/installation.md
    - Quick Start: getting_started/quickstart.md
    - Configuration: getting_started/configuration.md
  - Deployment:
    - Overview: deployment/index.md
    - Docker Compose: deployment/docker-compose.md
    - Kubernetes: deployment/kubernetes.md
    - Production Guide: deployment/production.md
  - API Reference:
    - Overview: api_reference/index.md
    - REST API: api_reference/rest-api.md
    - Worker API: api_reference/worker-api.md
    - OpenAI Compatible: api_reference/openai-compatible.md
  - Development:
    - Overview: development/index.md
    - Contributing: development/contributing.md
    - Architecture: development/architecture.md
    - Testing: development/testing.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lmstack/lmstack
  version:
    provider: mike