proxbox/mkdocs.yml at main · jon-the-dev/proxbox · 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
site_name: ProxBox
site_description: ProxBox - Your Proxmox toolbox for secure VM automation
site_author: ZeroDay Security
site_url: https://zerodaysec.github.io/proxmox-utilities

repo_name: zerodaysec/proxmox-utilities
repo_url: https://github.com/zerodaysec/proxmox-utilities
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2024 ZeroDay Security

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_category_heading: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
      - Configuration: getting-started/configuration.md
  - User Guide:
      - Creating Templates: user-guide/templates.md
      - Managing VMs: user-guide/vms.md
      - CLI Reference: user-guide/cli.md
      - Environment Variables: user-guide/environment.md
  - Security:
      - Overview: security/overview.md
      - Best Practices: security/best-practices.md
      - Threat Model: security/threat-model.md
  - Development:
      - Contributing: development/contributing.md
      - Testing: development/testing.md
      - Release Process: development/release.md
  - API Reference:
      - Config: api/config.md
      - Template: api/template.md
      - VM: api/vm.md
      - Utils: api/utils.md
      - Exceptions: api/exceptions.md
  - Changelog: changelog.md