mkdocs.yml

site_name: Paperless-ngx
theme:
  name: material
  logo: assets/logo.svg
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.tabs
    - navigation.top
    - toc.integrate
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github
  favicon: assets/favicon.png
repo_url: https://github.com/paperless-ngx/paperless-ngx
repo_name: paperless-ngx/paperless-ngx
edit_uri: blob/main/docs/
extra_css:
  - assets/extra.css
markdown_extensions:
  - attr_list
  - md_in_html
  - def_list
  - admonition
  - tables
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - footnotes
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
strict: true
nav:
    - index.md
    - setup.md
    - 'Basic Usage': usage.md
    - configuration.md
    - administration.md
    - advanced_usage.md
    - 'REST API': api.md
    - development.md
    - 'FAQs': faq.md
    - troubleshooting.md
    - changelog.md
copyright: Copyright © 2016 - 2023 Daniel Quinn, Jonas Winkler, and the Paperless-ngx team
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/paperless-ngx/paperless-ngx
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/paperlessngx/paperless-ngx
    - icon: material/chat
      link: https://matrix.to/#/#paperless:matrix.org
plugins:
  - search
  - glightbox:
       skip_classes:
         - no-lightbox