mkdocs.yml

site_name: RaspAP Documentation
site_url: "https://docs.raspap.com"
repo_url: https://github.com/RaspAP/raspap-webgui
repo_name: RaspAP/raspap-webgui
edit_uri: /RaspAP/raspap-docs/edit/master/docs

nav:
  - Overview: index.md
  - Get Started:
    - Get Started: get-started/index.md
    - Simple setup: get-started/simple-setup.md
    - Default settings: get-started/defaults.md
    - Manual installation: get-started/manual.md
    - Quick installer: get-started/quick-installer.md
    - Docker support: get-started/docker.md
    - Troubleshooting: get-started/troubleshooting.md
  - Core Features: 
    - Core Features: features-core/index.md
    - Ad blocking: features-core/adblock.md
    - Access point settings: features-core/ap-basics.md
    - Authentication: features-core/authentication.md
    - Bridged AP mode: features-core/bridged.md
    - Custom user plugins: features-core/custom-plugins.md
    - Dynamic DNS: features-core/dynamicdns.md
    - Firewall: features-core/firewall.md
    - Minimal SD card write: features-core/minwrite.md
    - NTP service: features-core/ntp.md
    - OpenVPN: features-core/openvpn.md
    - Speed testing: features-core/speedtest.md
    - SSL certificates: features-core/ssl.md
    - Translations: features-core/translations.md
    - WiFi repeater: features-core/repeater.md
    - WireGuard: features-core/wireguard.md
  - Experimental Features:
    - Experimental Features: features-experimental/index.md
    - AP-STA mode: features-experimental/ap-sta.md
    - RESTful API: features-experimental/restapi.md
    - VPN providers: features-experimental/providers.md
  - Insiders:
    - Insiders: features-insiders/index.md
    - AP isolation mode: features-insiders/ap-isolation.md
    - Captive portal: features-insiders/captive.md
    - Custom user avatars: features-core/authentication/#custom-user-avatars
    - Inspect network adapters: get-started/troubleshooting/#inspect-network-adapters
    - Limited privilege user: features-core/authentication/#limited-privilege-user-role
    - MAC address cloning: features-insiders/net-devices/#mac-address-cloning
    - Multiple WireGuard configs: features-core/wireguard/#multiple-configs
    - Network devices: features-insiders/net-devices.md
    - Tailscale VPN: features-insiders/tailscale.md
    - WiFi repeater mode: features-core/repeater/#alternate-routing-method
    - Wireless LAN routing: features-insiders/wlanrouting.md
    - Wireshark support: features-insiders/wireshark.md
  - FAQ: faq.md
  - Reporting Issues: issues.md
  - Get involved: get_involved.md

theme:
  name: material
  logo: images/favicon-32x32.png
  icon:
      admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/flame-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - navigation.tracking
    - content.action.edit
    - content.action.view
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.tabs.link
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.smartsymbols
  - pymdownx.keys
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
plugins:
  - search
  - social:
      cards_layout_options:
        background_color: #2b8080
  - git-revision-date-localized
  - git-committers:
      repository: RaspAP/raspap-docs
      branch: master
      token: !ENV MKDOCS_GIT_COMMITTERS_APIKEY
      enabled: !ENV [CI, false]
  - mkdocs-video
  - glightbox
  - redirects:
      redirect_maps:
        # mappings for features-core
        'adblock.md': 'features-core/adblock.md' 
        'ap-basics.md': 'features-core/ap-basics.md'
        'authentication.md': 'features-core/authentication.md'
        'bridged.md': 'features-core/bridged.md'
        'custom-plugins.md': 'features-core/custom-plugins.md'
        'dynamicdns.md': 'features-core/dynamicdns.md'
        'firewall.md': 'features-core/firewall.md'
        'minwrite.md': 'features-core/minwrite.md'
        'ntp.md': 'features-core/ntp.md'
        'openvpn.md': 'features-core/openvpn.md'
        'repeater.md': 'features-core/repeater.md'
        'speedtest.md': 'features-core/speedtest.md'
        'ssl.md': 'features-core/ssl.md'
        'translations.md': 'features-core/translations.md'
        'wireguard.md': 'features-core/wireguard.md'
        'ssl-quick.md': 'features-core/ssl.md'
        'ssl-manual.md': 'features-core/ssl.md#creating-a-certificate'
        # mappings for features-experimental
        'ap-sta.md': 'features-experimental/ap-sta.md'
        'providers.md': 'features-experimental/providers.md'
        'restapi.md': 'features-experimental/restapi.md'
        # mappings for features-insiders
        'insiders.md': 'features-insiders/index.md'
        'net-devices.md': 'features-insiders/net-devices.md'
        'tailscale.md': 'features-insiders/tailscale.md'
        'wlanrouting.md': 'features-insiders/wlanrouting.md'
        'captive.md': 'features-insiders/captive.md'
        'wireshark.md': 'features-insiders/wireshark.md'
        # mappings for get-started
        'defaults.md': 'get-started/defaults.md'
        'docker.md': 'get-started/docker.md'
        'manual.md': 'get-started/manual.md'
        'quick.md': 'get-started/quick-installer.md'
        'quick_start.md': 'get-started/simple-setup.md'
        'troubleshooting.md': 'get-started/troubleshooting.md'
extra_css:
  - stylesheets/extra.css
extra:
  analytics:
    provider: google
    property: G-8JKSE6SEPQ
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/rasp_ap
    - icon: fontawesome/brands/github
      link: https://github.com/RaspAP/
    - icon: fontawesome/brands/reddit-alien
      link: https://reddit.com/r/RaspAP
copyright: Copyright &copy; 2013 - 2025 <a href="https://github.com/RaspAP">RaspAP</a>