mkdocs.yml

# Project information
site_name: Contribuer à Geotribu
site_description: >-
  Guides de contribution au site participatif Geotribu et outillage interne.

site_author: Geotribu
site_url: https://contribuer.geotribu.fr/
copyright: '<span class="copyleft">&copy;</span> Geotribu'

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

# Custom folder structure
docs_dir: "./content"
site_dir: "./build/mkdocs/site"

# Scripts pendant le build
hooks:
  - hooks/mkdocs/G003_social_cards_adapter.py
  - hooks/mkdocs/G005_jinja_filters.py

# Plugins
plugins:
  - awesome-pages
  - exclude:
      glob:
        - "*/templates/*"
        - "*.yml"
  - git-authors:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_GIT_AUTHORS, true]
      show_contribution: true
  - git-committers:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_GIT_COMMITTERS, false]
      branch: main
      cache_dir:
        !ENV [
          MKDOCS_PLUGIN_GIT_COMMITTERS_CACHE_DIR,
          .cache/plugins/git-committers/,
        ]
      docs_path: content/
      repository: geotribu/site-contribuer
      token:
        !ENV ["GH_TOKEN_MATERIAL_INSIDERS", !ENV ["GH_TOKEN_MATERIAL_INSIDERS"]]
  - git-revision-date-localized:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_GIT_DATES, true]
      enable_creation_date: true
      fallback_to_build_date: true
      locale: fr
  - glightbox:
      touchNavigation: true
      effect: zoom
      width: 90%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - img-rdp-news-thumb
        - emojione
        - twemoji
      auto_caption: true
      caption_position: bottom
  - macros:
      include_dir: content/toc_nav_ignored/snippets
      module_name: hooks/macros/custom_jinja
  - meta
  - minify:
      minify_html: true
  - privacy:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_PRIVACY, true]
      cache_dir:
        !ENV [MKDOCS_PLUGIN_PRIVACY_EXTERNAL_CACHE_DIR, .cache/plugins/privacy]
      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
        - cdn.jsdelivr.net/**/*/twemoji*
        - cdnjs.cloudflare.com/ajax/libs/twemoji/*
        - github.com/**/*.gif
        - i.imgur.com/*
        - raw.githubusercontent.com/*
        - twemoji.maxcdn.com/*
        - upload.wikimedia.org/*
        - user-images.githubusercontent.com/**/*.gif
  - rss:
      abstract_chars_count: 500
      categories:
        - categories
        - tags
      comments_path: "#__comments"
      date_from_meta:
        as_creation: date
        datetime_format: "%Y-%m-%d"
        default_timezone: Europe/Paris
        default_time: "19:00"
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_RSS, false]
      image: theme/assets/images/geotribu/geotribu_logo_tipi_seul_carre.png
      length: 50
      match_path: "(articles|edit|guides|internal|rdp)/.*"
      pretty_print: false
      use_material_social_cards: true
      url_parameters:
        utm_source: "rss-feed"
        utm_medium: "RSS"
        utm_campaign: "feed-syndication"
  - search:
      lang: fr
  - social:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL, false]
      cache_dir: !ENV [MKDOCS_PLUGIN_SOCIAL_CACHE_DIR, .cache/plugins/social]
      cards: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL_CARDS, false]
      cards_exclude:
        - team/*.md
        - toc_nav_ignored/*.md
      cards_layout_options:
        background_color: "#3e93a7"
        font_family: Ubuntu
  - tags:
      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_TAGS, true]
      tags_sort_by: !!python/name:material.plugins.tags.tag_name_casefold
      listings_sort_by: !!python/name:material.plugins.tags.item_url

theme:
  name: "material"
  insiders_flavor: true
  custom_dir: "./content/theme/"
  favicon: theme/assets/images/geotribu/geotribu_logo_tipi_seul_carre.png
  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.instant.preview
    - navigation.path
    - navigation.prune
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  font:
    code: Ubuntu Mono
    text: Ubuntu
  language: fr
  logo: theme/assets/images/geotribu/geotribu_logo_tipi_seul_carre.png
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Basculer en mode clair

    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Basculer en mode sombre

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Basculer sur le réglage système

# Customization
extra:
  geotribu_main_site: https://geotribu.fr/
  theme_insiders_flavor: true
  consent:
    title: Consentement 🍪
    actions:
      - accept
      - reject
    cookies:
      analytics: matomo
    description: >
      Nous utilisons des cookies pour le goûter mais aussi pour vous proposer
      des fonctionnalités (commentaires, thème clair ou sombre, etc.) et mesurer
      l'audience du site.

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

extra_javascript:
  - path: https://mapstodon.space/embed.js
    defer: true
    async: true
  - path: https://platform.twitter.com/widgets.js
    defer: true
    async: true

# Extensions to enhance markdown - see: https://squidfunk.github.io/mkdocs-material/getting-started/#extensions
markdown_extensions:
  - abbr
  # Admonition - https://squidfunk.github.io/mkdocs-material/extensions/admonition/
  - admonition
  - attr_list
  # Footnotes - https://squidfunk.github.io/mkdocs-material/reference/footnotes/
  - footnotes
  - md_in_html
  # PyMdown extensions - https://squidfunk.github.io/mkdocs-material/extensions/pymdown/
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.saneheaders
  # https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
  - pymdownx.snippets:
      auto_append: [content/toc_nav_ignored/snippets/glossaire.md]
      base_path:
        - "."
      check_paths: true
      url_download: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  # Permalinks - https://squidfunk.github.io/mkdocs-material/extensions/permalinks/
  - toc:
      permalink: "#"

validation:
  links:
    absolute_links: warn
    not_found: warn
    unrecognized_links: warn
  nav:
    absolute_links: warn
    not_found: warn
    omitted_files: warn