quite/mkdocs.yml at develop · mathisloge/quite · 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
site_name: quite
site_url: https://github.com/mathisloge/quite/
site_author: Mathis Logemann

repo_name: mathisloge/quite
repo_url: https://github.com/mathisloge/quite/
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2024 - 2025 Mathis Logemann

theme:
  name: material
  logo: favicon.svg
  favicon: favicon.svg
  palette:
    scheme: slate
    primary: black
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.top
    - navigation.tabs
    - navigation.tracking
    - navigation.instant
    - navigation.instant.progress
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

site_dir: ../build/public

nav:
  - Home: index.md
  - Documentation:
    - Installation: getting-started.md
    - Probe setup: probe-setup.md
    - Python usage: python-usage.md
    - Building: building.md
  - Community:
    - Contributing: contributing.md
  - Blog:
    - blog/index.md

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

plugins:
  - search
  - blog
  - social
  - privacy:
      enabled: !ENV [CI, false]

extra:
  version:
    provider: mike