mkdocs.yml

site_name: RaspAP Documentation
site_url: ""
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
  - Quick Start:
    - Simple setup: quick_start.md
    - Default settings: defaults.md
    - Manual installation: manual.md
    - Quick installer: quick.md
    - Docker support: docker.md
    - Troubleshooting: troubleshooting.md
  - Core Features: 
    - Ad blocking: adblock.md
    - Access point settings: ap-basics.md
    - Authentication: authentication.md
    - Bridged AP mode: bridged.md
    - Captive portal setup: captive.md
    - Custom user plugins: custom-plugins.md
    - Minimal SD card write: minwrite.md
    - OpenVPN: openvpn.md
    - Translations: translations.md
    - WiFi repeater: repeater.md
    - WireGuard: wireguard.md
  - Insiders:
    - Features: insiders.md
    - Dynamic DNS: dynamicdns.md
    - Firewall: firewall.md
    - Network devices: net-devices.md
    - NTP Service: ntp.md
    - Speed testing: speedtest.md
    - Wireless LAN routing: wlanrouting.md
  - Experimental Features:
    - AP-STA mode: ap-sta.md
    - RESTful API: restapi.md
    - VPN providers: providers.md
    - SSL certificates: ssl.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.instant
    - navigation.tracking
    - navigation.footer
    - navigation.expand
    - navigation.instant
    - navigation.instant.progress
    - content.action.edit
    - content.action.view
    - search.suggest
    - search.highlight
    - search.share
    - navigation.top
    - 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
plugins:
  - search
  - git-revision-date-localized
  - git-committers:
      repository: RaspAP/raspap-docs
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>