quantized-containerized-models/mkdocs.yml at main · ParagEkbote/quantized-containerized-models · 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
site_name: "Quantized-Containerized-Models"
site_description: "Documentation for quantized and containerized AI model deployments."

docs_dir: "docs"
# site_url: "https://paragekbote.github.io/quantized-containerized-models/"

nav:
  - Home: index.md
  - Quick Start: quickstart.md
  - Architecture: architecture.md
  - Deployments & API: deployment.md
  - Examples: examples.md

theme:
  name: "material"
  font:
    text: Roboto

  logo: assets/project_hero_img.webp
  favicon: assets/project_hero_img.ico

  features:
    - navigation.footer
    - navigation.top
    - toc.follow
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit        # Adds edit button for GitHub
    - content.code.annotate
    - content.tabs.link
    - content.tooltips

  palette:
    # Light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Light mode
      primary: white
      accent: amber

    # Dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Dark mode
      primary: black
      accent: amber


extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ParagEkbote/quantized-containerized-models
      name: Source Code


markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - md_in_html
  - pymdownx.blocks.caption

  # Table of contents with anchors
  - toc:
      permalink: true

  # Code highlighting improvements
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true

  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
        - name: code
          class: code


  # Tabs for code examples
  - pymdownx.tabbed:
      alternate_style: true

  # Snippets, inline highlighting
  - pymdownx.inlinehilite
  - pymdownx.snippets