pmox/mkdocs.yml at main · lukebward/pmox · 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
site_name: pmox
site_url: https://lukebward.github.io/pmox/
site_description: >-
  A CLI for exploring and managing a Proxmox VE cluster, built so AI agents can
  drive it safely. Read-only by default.
site_author: Luke Ward
copyright: MIT © 2026 Luke Ward

repo_url: https://github.com/lukebward/pmox
repo_name: lukebward/pmox
edit_uri: edit/main/docs/

theme:
  name: material
  icon:
    logo: material/server-network
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - content.action.edit

nav:
  - Home: index.md
  - Quick start: quick-start.md
  - Safety model: safety.md
  - Guides:
      - Provisioning: provisioning.md
      - Using with an AI agent: agents.md
  - Reference:
      - Commands: commands.md
      - Configuration: configuration.md
  - Development: development.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

# Fail the build on a bad cross-reference, not just a bad file path.
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lukebward/pmox
      name: pmox on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pmox/
      name: pmox on PyPI

# Everything under docs/ is published. Design specs and implementation plans
# live in .superpowers/ at the repo root, deliberately outside this tree.
exclude_docs: |
  demo.cast