docksight/mkdocs.yml at develop · Open-Source-Kigali/docksight · 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: DockSight
site_description: >-
  Open-source Docker management and observability platform. Manage many remote
  Docker hosts from one dashboard, with agents that never expose an inbound port.
site_author: DockSight contributors
site_url: https://Open-Source-Kigali.github.io/docksight/

repo_name: Open-Source-Kigali/docksight
repo_url: https://github.com/Open-Source-Kigali/docksight
edit_uri: edit/main/docs/

copyright: Copyright &copy; DockSight contributors

theme:
  name: material
  language: en

  icon:
    repo: fontawesome/brands/github
    logo: material/docker

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit

  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - search:
      lang: en

markdown_extensions:
  # Callouts: !!! note, !!! warning, ??? tip
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - footnotes
  - tables
  - toc:
      permalink: true
      permalink_title: Link to this section
      toc_depth: 3

  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

  # Mermaid diagrams render from ```mermaid fences.
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Home: index.md
  - Getting started:
      - Introduction: introduction.md
      - Architecture: architecture.md
      - Installation: installation.md
  - Components:
      - Platform: platform.md
      - Agent: agent.md
      - CLI reference: cli.md
      - WebSocket protocol: websocket-protocol.md
      - Protocol specification: protocol.md
      - HTTP API: api/README.md
  - Operations:
      - Security: security.md
      - Release process: release-process.md
      - FAQ: faq.md
  - Project:
      - Development: development.md
      - Contributing: contributing.md
      - Roadmap: roadmap.md
      - Decision records:
          - ADR 001 — Stack selection: decisions/001-stack-selection.md
          - ADR 002 — Database selection: decisions/002-database-selection.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Open-Source-Kigali/docksight
      name: DockSight on GitHub

  generator: false

extra_css:
  - stylesheets/extra.css