blackstart/mkdocs.yml at main · pezops/blackstart · 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
site_name: Blackstart
site_url: https://pezops.github.io/blackstart
site_description: Declarative and secure infrastructure bootstrapping.
site_author: Mike

repo_url: https://github.com/pezops/blackstart
edit_uri: blob/master/docs/

theme:
  logo: images/power-outline.svg
  name: material
  features:
    - navigation.indexes
    - navigation.path
    - navigation.top
    - toc.follow

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

nav:
  - Introduction: README.md
  - Getting Started: getting-started.md
  - User Guide:
      - user-guide/README.md
      - Deploy: user-guide/deploy.md
      - Configuration: user-guide/configuration.md
      - Workflows: user-guide/workflows.md
      - Eventual Consistency: user-guide/eventual-consistency.md
      - Secure Practices: user-guide/secure-practices.md
      - Modules: user-guide/modules/*
  - Developer Guide:
      - developer-guide/README.md
      - Modules: developer-guide/modules.md
      - Core Types: developer-guide/types.md
      - Building: developer-guide/building.md
      - Release Process: developer-guide/release.md
  - About:
      - about/README.md
      - Release Notes: https://github.com/pezops/blackstart/releases
      - License: https://github.com/pezops/blackstart/blob/main/LICENSE

extra_css:
  - 'css/extra.css'

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
  - pymdownx.snippets

plugins:
  - search
  - literate-nav
#  - literate-nav:
#      implicit_index: true