wg-portal/mkdocs.yml
2025-01-23 13:42:51 +01:00

74 lines
2.0 KiB
YAML

---
site_name: WireGuard Portal
site_description: Manage WireGuard Peers and Interface using a beautiful and simple web UI.
site_url: https://wgportal.org/
repo_name: h44z/wg-portal
repo_url: https://github.com/h44z/wg-portal
copyright: Copyright © 2023-2025 WireGuard Portal Project
extra_css:
- stylesheets/extra.css
theme:
name: material
custom_dir: docs/theme-overrides
palette:
primary: white
font: false
logo: assets/images/logo.svg
favicon: assets/images/favicon-large.png
language: en
features:
- content.code.copy
- navigation.instant
- navigation.tabs
- navigation.expand
plugins:
- search
- social
- minify:
minify_html: true
- swagger-ui-tag
extra:
version:
provider: mike
default: latest
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/h44z/wg-portal
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/wgportal/wg-portal
- icon: fontawesome/brands/twitter
link: https://twitter.com/chris_h44z
markdown_extensions:
- admonition
- meta
- pymdownx.details
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tilde
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
nav:
- Home: index.md
- Documentation:
- Overview: documentation/overview.md
- Getting Started:
- Binaries: documentation/getting-started/binaries.md
- Docker: documentation/getting-started/docker.md
- Helm: documentation/getting-started/helm.md
- Sources: documentation/getting-started/sources.md
- Configuration:
- Overview: documentation/configuration/overview.md
- Examples: documentation/configuration/examples.md
- Upgrade: documentation/upgrade/v1.md
- Monitoring: documentation/monitoring/prometheus.md
- REST API: documentation/rest-api/api-doc.md