wg-portal/mkdocs.yml

# build with MkDocs 1.5.3, mkdocs-material-9.4.7

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-2024 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:
    - tabs
    - instant
    - navigation.tabs

plugins:
  - search
  #- social # disable until https://github.com/squidfunk/mkdocs-material/issues/6983 is resolved

extra:
  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.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:
          - Building: documentation/getting-started/building.md
          - Docker Container: documentation/getting-started/docker.md
          - Upgrade from V1: documentation/getting-started/upgrade.md