mkdocs.yml

# Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: Maintainerr Documentation
site_url: https://docs.maintainerr.info/
site_author: ydkmlt84
site_description: >-
  Documentation for the wildly popular Maintainerr project.
use_directory_urls: true
# Repository
repo_name: maintainerr/maintainerr
repo_url: https://github.com/maintainerr/maintainerr
copyright: Copyright &copy; Maintainerr

# Configuration
theme:
  name: material
  custom_dir: docs/overrides
  features:
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - content.footnote.tooltips
    - content.tabs.link
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    #- navigation.instant
    # - navigation.instant.prefetch
    #- navigation.instant.progress
    # - navigation.instant.preview
    # - navigation.path
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    # - navigation.tracking
    - search.highlight
    - search.share
    - toc.follow
    # - toc.integrate
  icon:
    repo: material/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: grey
      accent: orange
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: grey
      accent: orange
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: images/favicon.ico
  logo: images/logo_icon.svg

# Plugins
plugins:
  - blog:
      blog_toc: true
      post_url_format: "/{categories}/{slug}"
      categories_slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - mike:
      # These fields are all optional; the defaults are as below...
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: docs/stylesheets
      javascript_dir: docs/assets/javascripts
  - git-revision-date-localized:
      enable_creation_date: true
      type: date
  - git-committers:
      repository: ydkmlt84/Maintainerr_docs
      branch: main
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - social:
      cards_layout: custom_card
      cards_layout_dir: layouts
  - glightbox
  - swagger-ui-tag
  - optimize
# Hooks
hooks:
  - docs/overrides/hooks/shortcodes.py
  - docs/overrides/hooks/translations.py

# Additional configuration
extra_css:
  - assets/stylesheets/extra.css
extra:
  annotate:
    json: [.s2]
  analytics:
    provider: matomo
    property: docs
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: fontawesome/solid/thumbs-up
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!

        - icon: fontawesome/solid/thumbs-down
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            submitting an issue to the docs repo. <a href="https://github.com/ydkmlt84/Maintainerr_docs/issues/new/choose" target="_blank">Docs Repo New Issue</a>
  consent:
    title: Help us, help you! (consent to cookies)
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation. With your consent, you're helping us to
      make our documentation better. <a href="https://maintainerr.info/privacy.html" target="_blank">Privacy Policy</a>
    cookies:
      analytics: Maintainerr's self-hosted analytics system (Matomo).
    actions:
      - accept
      - reject
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/maintainerr/maintainerr
      name: Github
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/maintainerr/maintainerr/
      name: Docker Hub
    - icon: fontawesome/brands/discord
      link: https://discord.gg/WP4ZW2QYwk
      name: Discord
    - icon: material/cookie-cog
      link: '#__consent'
      name: Cookie Settings
    - icon: material/gavel
      link: https://github.com/Maintainerr/Maintainerr/blob/main/LICENSE
      name: License
  status:
    new: Recently Added
    deprecated: Deprecated
    recent: New Updates
  version:
    provider: mike
    default: latest
# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  #- material.extensions.preview:
  #    targets:
  #      include:
  #        - changelog/index.md
  #        - customization.md
  #        - insiders/changelog/*
  #        - docs/extensions/*
  - pymdownx.critic
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      #auto_append:
      #  - includes/mkdocs.md
      url_download: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Getting started:
    - Installation.md
    - Configuration.md
    - Migration.md
    - Works.md
    - Common.md
    - ReverseProxy.md
    - Downgrade.md
  - Rules:
    - Rules.md
    - Glossary.md
  - Collections: 
    - Collections.md
    - Test-Media.md
  - Notifications:
    - Notifications.md
  - Community:
    - Introduction.md
    - Contributing.md
    - Testing.md
    - Changelog.md
  - API:
    - API.md  
  - Walkthroughs:
    - blog/index.md