mkdocs.yml

site_name: Papermerge 3
site_url: https://docs.papermerge.io
nav:
  - Setup:
    - setup/overview.md
    - setup/requirements.md
    - setup/docker.md
    - setup/docker-compose.md
    - setup/backup.md
    - setup/upgrading.md
  - User Manual:
    - user/getting-started.md
    - user/user-interface.md
    - user/upload-documents.md
    - user/tags-and-folders.md
    - user/page-management.md
    - user/metadata.md
    - user/versions.md
    - user/merge-documents.md
    - user/ocr.md
    - user/automates.md
    - user/file-formats.md
    - user/user-management.md
    - user/rest-api-token.md
  - Settings:
    - settings/overview.md
    - settings/auth.md
    - settings/main.md
    - settings/security.md
    - settings/ocr.md
    - settings/database.md
    - settings/redis.md
    - settings/search.md
  - "backup-restore.md"
  - REST API:
    - "rest-api/overview.md"
    - "rest-api/reference.md"
  - Command Line Utilities:
    - cli/overview.md
    - cli/cli.md
  - Contributor Manual:
    - contributor/frontend.md
    - contributor/backend.md
  - "changelog.md"

theme:
  name: material
  palette:
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: indigo
    accent: amber
    toggle:
      icon: material/lightbulb
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: indigo
    accent: amber
    toggle:
      icon: material/lightbulb-outline
      name: Switch to light mode
  features:
  - search.suggest
  - search.highlight
  - navigation.top
#  - content.tabs.link
#  - navigation.indexes
  - content.tooltips
#  - navigation.path
  - content.code.annotate
  - content.code.copy
  - content.code.select
repo_url: https://github.com/ciur/papermerge
extra:
  project: Papermerge  # custom variable for macros plugin
  docker_image_version: 3.0a2  # latest docker image version e.g. 3.0, 3.0.1, 3.1.9, 3.0a1
  version:
    provider: mike
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/ciur/papermerge
  - icon: fontawesome/solid/globe
    link: https://papermerge.com
extra_css:
  - css/custom.css

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - tables
  - attr_list
  - md_in_html
plugins:
  - macros
  - search