CAIRA/mkdocs.yml at main · cmaclaughlin/CAIRA · 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
---
site_name: CAIRA
site_description: Composable AI Reference Architectures
site_author: Microsoft Corporation
site_url: https://microsoft.github.io/CAIRA/
use_directory_urls: true
repo_name: microsoft/CAIRA
repo_url: https://github.com/microsoft/CAIRA
edit_uri: edit/main/docs/
remote_branch: main
remote_name: origin
theme:
  name: material
  language: en
  icon:
    logo: octicons/ruby-24
    admonition:
      note: octicons/info-16
      warning: octicons/alert-16
      danger: octicons/alert-16
    repo: octicons/mark-github-24
    edit: octicons/pencil-24
    view: octicons/eye-24
  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.action.edit
    - content.tooltips
    - navigation.indexes
    - navigation.instant
    - navigation.prune
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
    - announce.dismiss
  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: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: amber
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - search:
      lang: en
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mermaid2
  - awesome-nav
  # - mike
  - minify:
      minify_css: true
      minify_html: true
      minify_js: true

validation:
  links:
    absolute_links: relative_to_docs
    anchors: warn
    unrecognized_links: warn

markdown_extensions:
  - meta
  - abbr
  - admonition
  - attr_list
  - toc:
      permalink: true
  - pymdownx.smartsymbols
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: 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

copyright: Copyright &copy; 2025 Microsoft Corporation
# hooks:
#   - .github/dev/tfdocs.py

extra:
  # version:
  #   provider: mike
  #   default: latest
  #   alias: true
  social:
    - icon: octicons/mark-github-24
      link: https://github.com/microsoft/CAIRA
  generator: false