boring-registry/mkdocs.yaml at main · appcd-dev/boring-registry · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
site_name: boring-registry
site_author: boring-registry maintainers
repo_name: boring-registry/boring-registry
repo_url: https://github.com/boring-registry/boring-registry/

docs_dir: docs

nav:
  - README.md
  - Installation:
    - Helm: installation/helm.md
    - Docker: installation/docker.md
    - Source: installation/source.md
  - Configuration:
    - Introduction: configuration/introduction.md
    - Storage Layout: configuration/storage-layout.md
    - Storage Backends:
      - AWS S3: configuration/storage-backends/aws-s3.md
      - Azure Blob Storage: configuration/storage-backends/azure-blob-storage.md
      - Google Cloud Storage: configuration/storage-backends/google-cloud-storage.md
      - MinIO: configuration/storage-backends/minio.md
    - Authentication:
      - API Token: configuration/authentication/api-token.md
      - OIDC: configuration/authentication/oidc.md
      - Okta: configuration/authentication/okta.md
    - Download Proxy: configuration/download-proxy.md
    - Provider Network Mirror: configuration/provider-network-mirror.md
  - Tasks:
    - Publish Modules: tasks/publish-modules.md
    - Publish Providers: tasks/publish-providers.md

theme:
  theme:
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

  name: material
  features:
    - content.code.annotate
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky

extra:
  version:
    provider: mike

markdown_extensions:
  - meta
  - tables
  - toc:
      permalink: true
  - abbr
  - extra
  - admonition
  - smarty
  - sane_lists
  - nl2br
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - literate-nav
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true