circus/mkdocs.yml at main · SPQRTeam/circus · 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
site_name: SPQR Team
site_description: SPQR Team Documentation
copyright: "2025, SPQR Team"
site_url: https://mydomain.org/mysite # TODO
repo_url: https://github.com/DaniAffCH/circus
repo_name: SPQRTeam/circus

nav:
  - Overview: index.md
  - Circus:
      - Introduction: circus/introduction.md
      - Installation: circus/installation.md
      - Circus Architecture Overview: circus/architecture.md

theme:
  name: material
  favicon: assets/logo.png
  logo: assets/logo_bw.png
  font:
    text: Red Hat Text
    code: JetBrains Mono

  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: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

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

  features:
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.code.annotate
    - content.tooltips
    - content.code.select
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer

  icon:
    edit: material/pencil
    view: material/eye
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css