chithi/mkdocs.yml at main · SUNET/chithi · 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
site_name: Chithi
site_url: https://chithi.org
site_description: A privacy-focused desktop email, calendar, and contacts client.
site_author: Chithi authors
copyright: Copyright &copy; 2026 Chithi authors

repo_url: https://github.com/SUNET/chithi
repo_name: SUNET/chithi
edit_uri: edit/main/web/

# Public website source lives under `web/`, kept separate from the
# in-repo `docs/` (features overview + ADRs) which is for project
# contributors and does not get published to chithi.org.
docs_dir: web

# `web/CNAME` and the static OAuth bounce under
# `web/oauth/zoom/index.html` are not documentation pages but
# need to round-trip through the build untouched. mkdocs copies
# unrecognised files in the docs source verbatim; this entry
# silences the "not in nav" warnings the strict CI build would
# otherwise emit.
not_in_nav: |
  /CNAME
  /oauth/**

nav:
  - Home: index.md
  - User guide:
      - Overview: user/index.md
      - Install Chithi: user/install.md
      - First launch: user/getting-started.md
      - Account setup: user/accounts.md
      - Meeting integrations:
          - Nextcloud Talk: user/nextcloud-talk.md
          - Matrix / Element Call: user/matrix-element-call.md
          - Zoom: user/zoom.md
          - La Suite Visio: user/la-suite-visio.md
      - Troubleshooting: user/troubleshooting.md
      - Privacy and local data: user/data-removal.md
  - Administration: admin/index.md
  - Reviewer documentation:
      - Zoom Marketplace test plan: zoom-test-plan.md
  - Project:
      - Privacy policy: privacy.md
      - Terms of use: terms.md

theme:
  name: material
  language: en
  palette:
    # Match the warm-amber chrome the desktop app uses (ADR 0043).
    - scheme: default
      primary: amber
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: amber
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - content.action.edit
    - content.code.copy
    - toc.follow

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true