vault/mkdocs.yaml at main · jonco5555/vault · 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: Vault
repo_url: https://github.com/jonco5555/vault
nav:
  - Home: index.md
  - Design: design_implementation.md
  - Advanced Details: advanced_details.md
  - Evaluations: evaluation.md
  - How to run: how_to_run.md
  - Code Reference: reference/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
          icon: material/toggle-switch-off-outline
          name: Switch to dark mode
      primary: blue grey
      accent: blue grey
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
          icon: material/toggle-switch
          name: Switch to light mode
      primary: blue grey
      accent: blue grey
  font:
    text: Roboto
    code: Roboto Mono
  logo: assets/icon.png
  favicon: assets/icon.png
  features:
    - navigation.tabs
    - navigation.top
    - navigation.tabs.sticky
    - navigation.footer
    - navigation.expand
    - search.highlight
    - search.suggest
    - toc.integrate
    - content.code.copy
plugins:
  - search
  - awesome-pages
  - gen-files:
      scripts:
      - docs/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings
  - section-index
  - with-pdf:
      cover_title: Vault
      cover_subtitle: Distributed Secret Manager. By Ariel Shnits and Yonatan Cohen
      cover_logo: assets/logo.png
      output_path: pdf/vault.pdf
      enabled_if_env: ENABLE_PDF_EXPORT
      exclude_pages:
        - 'reference/*'
  - print-site:
      print_page_title: Vault
      exclude:
        - 'reference/*'
markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.highlight:
      linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.snippets:
      restrict_base_path: false
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - attr_list
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jonco5555/vault