rhiza-cli/mkdocs.yml at main · Jebel-Quant/rhiza-cli · 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
INHERIT: docs/mkdocs-base.yml

site_name: Rhiza CLI
site_description: Reusable configuration templates for modern Python projects
site_url: https://jebel-quant.github.io/rhiza-cli/
repo_url: https://github.com/jebel-quant/rhiza-cli
repo_name: jebel-quant/rhiza-cli
edit_uri: edit/main/

docs_dir: docs  # must not be '.' (project root) — _book would then be inside docs_dir, which MkDocs rejects

theme:
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy

markdown_extensions:
  - md_in_html
  - admonition
  - attr_list
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: ["."]
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - Guides:
      - Authentication: AUTHENTICATION.md
      - Testing: development/TESTS.md
  - Decisions:
      - Overview: adr/README.md
      - ADR-0001 — Inline get_diff: adr/0001-inline-get-diff-instead-of-cruft.md
      - ADR-0002 — Repository/ref keys: adr/0002-repository-ref-as-canonical-keys.md
      - ADR-0003 — Lock file concurrency: adr/0003-lock-file-concurrency.md