108 lines
2.9 KiB
YAML
108 lines
2.9 KiB
YAML
site_name: cLAN documentation
|
|
site_url: https://docs.clan.lol
|
|
repo_url: https://git.clan.lol/clan/clan-core/
|
|
repo_name: clan-core
|
|
edit_uri: _edit/main/docs/docs/
|
|
|
|
validation:
|
|
omitted_files: warn
|
|
absolute_links: warn
|
|
unrecognized_links: warn
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- footnotes
|
|
- meta
|
|
- plantuml_markdown
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.details
|
|
- pymdownx.highlight:
|
|
use_pygments: true
|
|
- toc:
|
|
title: On this page
|
|
|
|
exclude_docs: |
|
|
.*
|
|
!templates/
|
|
/drafts/
|
|
|
|
nav:
|
|
- Getting started:
|
|
- index.md
|
|
- Configure: getting-started/configure.md
|
|
- Deploy Machine: getting-started/machines.md
|
|
- Installer: getting-started/installer.md
|
|
- Setup Networking: getting-started/networking.md
|
|
- Provision Secrets & Passwords: getting-started/secrets.md
|
|
- Backup & Restore: getting-started/backups.md
|
|
- Flake-parts: getting-started/flake-parts.md
|
|
- Templates: templates/index.md
|
|
- Reference:
|
|
- clan-core:
|
|
- reference/clan-core/index.md
|
|
- reference/clan-core/backups.md
|
|
- reference/clan-core/facts.md
|
|
- reference/clan-core/sops.md
|
|
- reference/clan-core/state.md
|
|
- clanModules:
|
|
- reference/clanModules/borgbackup.md
|
|
- reference/clanModules/deltachat.md
|
|
- reference/clanModules/disk-layouts.md
|
|
- reference/clanModules/ergochat.md
|
|
- reference/clanModules/localbackup.md
|
|
- reference/clanModules/localsend.md
|
|
- reference/clanModules/matrix-synapse.md
|
|
- reference/clanModules/moonlight.md
|
|
- reference/clanModules/root-password.md
|
|
- reference/clanModules/sshd.md
|
|
- reference/clanModules/sunshine.md
|
|
- reference/clanModules/syncthing.md
|
|
- reference/clanModules/thelounge.md
|
|
- reference/clanModules/xfce.md
|
|
- reference/clanModules/zt-tcp-relay.md
|
|
- Contributing: contributing/contributing.md
|
|
|
|
docs_dir: site
|
|
site_dir: out
|
|
|
|
theme:
|
|
logo: static/logo.png
|
|
name: material
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tabs
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
icon:
|
|
repo: fontawesome/brands/git
|
|
|
|
palette:
|
|
# Palette toggle for light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: teal
|
|
accent: deep purple
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
|
|
# Palette toggle for dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
primary: teal
|
|
accent: deep purple
|
|
scheme: slate
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
|
|
plugins:
|
|
- search
|