Gluttony-Cluster/mkdocs.yaml

96 lines
2.8 KiB
YAML
Raw Normal View History

2024-11-02 23:27:58 +00:00
site_name: Gluttony-Cluster
site_url: https://docs.clortox.com/cluster
site_description: Documentation on maintaining a datacenter at home
docs_dir: docs/
repo_name: Gitea
repo_url: https://git.clortox.com/Infrastructure/Gluttony-Cluster
2024-11-03 18:15:26 +00:00
edit_uri: src/branch/main/docs
2024-11-02 23:27:58 +00:00
2024-11-03 00:19:58 +00:00
nav:
2024-11-03 02:00:12 +00:00
- User Documentation:
2024-11-16 01:59:06 +00:00
- Overview: index.md
2024-11-03 21:24:17 +00:00
- Accounts:
- Registering a mail account: user/mailcow.md
2024-11-16 01:59:06 +00:00
- Registering an SSO account: user/account.md
- Registering a radicale account: user/radicale.md
2024-11-03 21:24:17 +00:00
- Media:
- Requesting Media: user/request.md
- Downloading Media: user/download.md
2024-11-16 01:59:06 +00:00
- Radicale (Calendars, contacts, etc):
- Android Phone Sync (DAVX5): user/davx5.md
- Making a Calendar: user/calendar.md
- Making a Contact Book: user/contacts.md
- Making a TODO List: user/todo.md
2024-11-03 02:00:12 +00:00
- Technical:
2024-11-03 21:24:17 +00:00
- Overview: technical/index.md
2024-11-16 01:59:06 +00:00
- Cluster Architecture: architecture.md
- Setup Cluster: technical/setup.md
2024-11-03 21:24:17 +00:00
- Conventions: technical/conventions.md
2024-11-09 20:33:12 +00:00
- Tier 0 (Infrastructure):
2024-11-03 21:24:17 +00:00
- MetalLB: technical/metallb.md
- Sealed Secrets: technical/sealed-secrets.md
- Nvidia Operator: technical/nvidia.md
- Longhorn: technical/longhorn.md
2024-11-09 20:33:12 +00:00
- Tier 1 (Dependencies):
- Postgresql: technical/postgresql.md
- PGAdmin: technical/pgadmin.md
2024-11-12 00:53:25 +00:00
- Reids: technical/redis.md
- Tier 2 (User Apps):
- Navidrome (Music): technical/navidrome.md
2024-11-03 21:24:17 +00:00
- Misc:
- NFS: technical/nfs-storage.md
2024-11-09 20:33:12 +00:00
- Seal-a-secret: technical/seal-a-secret.md
- Networking: technical/inter-pod-networking.md
2024-11-03 00:19:58 +00:00
2024-11-02 23:27:58 +00:00
theme:
name: material
#custom_dir: docs/overrides
language: "en"
2024-11-03 18:15:26 +00:00
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to dark mode
2024-11-02 23:47:27 +00:00
logo: img/logo.png
2024-11-03 18:15:26 +00:00
favicon: img/logo.png
2024-11-02 23:27:58 +00:00
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.footer
- content.action.edit
- content.tabs.link
- content.code.annotate
- content.code.copy
markdown_extensions:
- pymdownx.highlight
2024-11-03 00:19:58 +00:00
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
2024-11-02 23:27:58 +00:00
- admonition
- footnotes
- def_list
#- attr_list
#- pymdownx.tabbed:
# alternate_style: true
#- pymdownx.details
#- pymdownx.emoji:
# emoji_index: !!python/name:materialx.emoji.twemoji
# emoji_generator: !!python/name:materialx.emoji.to_svg
extra:
generator: false
version:
method: mike
provider: mike
default: latest