mkdocs.yml

site_name: PWAsForFirefox
site_description: A tool to install, manage and use Progressive Web Apps (PWAs) in Mozilla Firefox
site_author: filips
site_url: https://pwasforfirefox.filips.si

repo_name: filips123/PWAsForFirefox
repo_url: https://github.com/filips123/PWAsForFirefox

edit_uri: edit/main/docs/docs/

docs_dir: docs
site_dir: dist

theme:
  name: material

  logo: assets/icons/logo.svg
  favicon: assets/icons/favicon.svg

  custom_dir: overrides

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.footer
    - navigation.instant
    - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tracking
    - search.share
    - search.suggest
    - toc.follow

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tilde
  - toc:
      permalink: true
      title: Table of Contents
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|\.(?!\d)|&[lg]t;'
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      cache_safe: true
      htmlmin_opts:
        remove_comments: true
        reduce_boolean_attributes: true
      js_files:
        - assets/javascripts/statistics.js
        - assets/javascripts/feedback.js
      css_files:
        - assets/stylesheets/theme.css
  - macros

hooks:
  - hooks/breadcrumbs.py
  - hooks/home.py
  - hooks/faq.py

extra_javascript:
  - assets/javascripts/statistics.js
  - assets/javascripts/feedback.js

extra_css:
  - assets/stylesheets/theme.css

extra:
  social:
    - icon: fontawesome/brands/firefox
      link: https://addons.mozilla.org/firefox/addon/pwas-for-firefox/
      name: Firefox Add-ons
    - icon: fontawesome/brands/github
      link: https://github.com/filips123/PWAsForFirefox
      name: GitHub
    - icon: fontawesome/solid/bug
      link: https://github.com/filips123/PWAsForFirefox/issues
      name: GitHub Issues
    - icon: fontawesome/solid/comments
      link: https://github.com/filips123/PWAsForFirefox/discussions
      name: GitHub Discussions
  analytics:
    enabled: !ENV [ CI, false ]
    endpoints:
      views: https://www.filips.si/tools/pwasforfirefox/views.php
      feedback: https://www.filips.si/tools/pwasforfirefox/feedback.php
    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 <a href="https://github.com/filips123/PWAsForFirefox/issues/new?labels=enhancement,documentation&template=feature_request.md&title=Documentation feedback+for+*{title}*" target="_blank" rel="noopener">opening an issue</a>.

nav:
  - index.md
  - Installation:
      - installation/requirements.md
      - installation/extension.md
      - installation/native.md
      - installation/updates.md
  - User Guide:
      - user-guide/extension.md
      - user-guide/console.md
      - user-guide/browser.md
  # - Developer Guide:
      # TODO: How to access `firefoxpwa-connector` from third-party programs?
      # TODO: Some suggestions for third-party programs and integrations?
      # - developer-guide/todo.md
  - Resources:
      - resources/installation-directories.md
      - resources/specific-website-tips.md
      - resources/profile-properties.md
      - resources/web-app-properties.md
      # TODO: Document (un)supported manifest properties, specific web app APIs, etc.
  - Help:
      - help/support.md
      - help/troubleshooting.md
      - help/faq.md
  - About:
      - about/how-it-works.md
      - about/supported-features.md
      - about/current-limitations.md
      - about/privacy-policy.md
      - about/contributing.md