mkdocs.yml

# Project information
site_name: PyQGIS icon cheatsheet
site_description: >-
  Cheatsheet of icons embedded in QGIS with direct integration code for PyQGIS.
  Automatically generated every month.

site_author: Julien Moura (Geotribu)
site_url: https://pyqgis-icons-cheatsheet.geotribu.fr/
copyright: '<span class="copyleft">&copy;</span> Geotribu'

# Repository
repo_name: !ENV [GITHUB_REPOSITORY, "geotribu/pyqgis-icons-cheatsheet"]
repo_url: !ENV [MKDOCS_REPO_URL, "https://github.com/geotribu/pyqgis-icons-cheatsheet"]
edit_uri: !ENV [MKDOCS_EDIT_URI, "edit/main/content"]

# Plugins
plugins:
  - git-revision-date-localized:
      enable_creation_date: false
      fallback_to_build_date: true
      locale: en
  - meta
  - minify:
      minify_html: true
  - optimize:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_OPTIMIZE, true]
      optimize_jpg_quality: 80
      optimize_png_speed: 1
  - search:
      lang: en
  - privacy:
      enabled:  !ENV [MKDOCS_ENABLE_PLUGIN_PRIVACY, true]
      links_attr_map:
        target: _blank
      assets_exclude:
        # mandatory - https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/
        - cdn.jsdelivr.net/npm/mathjax@3/*
        - giscus.app/*
        # geotribu
        - cdn.geotribu.fr/images/*
        - cdn.geotribu.fr/img/*
        - geotribu.net/*
        # external
        - cdnjs.cloudflare.com/ajax/libs/twemoji/*
        - github.com/**/badge.svg
        - github.com/**/*.gif
        - img.shields.io/*
        - results.pre-commit.ci/*
        - twemoji.maxcdn.com/*
        - user-images.githubusercontent.com/**/*.gif
  - social:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL, true]
      cards: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL_CARDS, true]
      cards_layout_options:
        font_family: Ubuntu


# Theme
theme:
  name: "material"
  custom_dir: "./docs/theme/"
  favicon: theme/assets/images/pyqgis.png

  features:
    - content.code.copy
    - navigation.path
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  font:
    code: Ubuntu Mono
    text: Ubuntu

  language: en
  logo: theme/assets/images/pyqgis.png
  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)"
      accent: amber
      primary: green
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      accent: blue
      primary: teal
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

# Customization
extra:
  analytics:
    provider: matomo
    matomo_url: !ENV [MKDOCS_MATOMO_URL_BASE, "https://matomo.data-wax.com/"]
  geotribu_main_site: https://geotribu.fr/
  social:
  - icon: "fontawesome/brands/github-alt"
    link: "https://github.com/geotribu/"
    name: "Geotribu on Github"
  - icon: "fontawesome/brands/mastodon"
    link: https://mapstodon.space/web/@geotribu
    name: "Geotribu on Mapstodon"
  - icon: "fontawesome/brands/twitter"
    link: "https://twitter.com/geotribu"
    name: "Geotribu on Twitter"
  - icon: "fontawesome/brands/linkedin"
    link: "https://www.linkedin.com/feed/hashtag/?keywords=geotribu"
    name: "Geotribu on LinkedIn"
  - icon: "fontawesome/brands/youtube"
    link: https://www.youtube.com/@geotribu
    name: "Geotribu on Youtube"
  - icon: "fontawesome/brands/mailchimp"
    link: http://eepurl.com/hL0zVr
    name: "geotribu newsletter newsletter"
  - icon: fontawesome/solid/paper-plane
    link: mailto:<geotribu@gmail.com>
    name: "Contact us by email"
  - icon: "fontawesome/solid/piggy-bank"
    link: https://fr.tipeee.com/geotribu
    name: "Sponsor Geotribu"


extra_css:
  - "theme/assets/stylesheets/extra.css"

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - theme/assets/javascript/tablesort.js

# Extensions to enhance markdown - see: https://squidfunk.github.io/mkdocs-material/getting-started/#extensions
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      linenums: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tilde
  - tables
  - toc:
      permalink: "#"

nav:
  - Credits: credits.md
  - Cheatsheet: index.md
  - Plugin: https://plugins.qgis.org/plugins/pyqgis_resource_browser/
  - Geotribu: http://geotribu.fr/