CAPIO-website/mkdocs.yml at main · High-Performance-IO/CAPIO-website · 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
site_name: CAPIO
site_description: "CAPIO — Cross Application Programmable I/O: inject streaming capabilities into file-based legacy workflows."
site_url: https://capio.hpc4ai.it

# Single website. The whole source lives under content/:
#   content/index.md            -> /            (landing / home)
#   content/docs/**             -> /docs/...    (documentation)
#   content/schema/**           -> /schema/...  (CAPIO-CL JSON + redirect, copied as-is)
docs_dir: content

theme:
  name: material
  logo: assets/images/capio-logo-rounded-no-shadow.png
  favicon: assets/images/capio-logo-rounded.png
  font:
    text: Inter Tight
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs          # Home / Documentation as top-level tabs
    - navigation.tabs.sticky
    - navigation.indexes       # section landing pages (Documentation -> Welcome)
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - Documentation:
      - docs/index.md
      - Middleware:
          - docs/middleware/index.md
          - "CAPIO daemon": docs/middleware/server.md
          - "Intercept library": docs/middleware/posix.md
      - "CAPIO-CL": https://capio.hpc4ai.it/capiocl/
      - "PyCAPIO": https://capio.hpc4ai.it/pycapio/

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - footnotes
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/High-Performance-IO/capio
      name: CAPIO on GitHub