mkdocs.yml

site_name: Tildagon Badge Documentation
site_description: "Documentation for the Tildagon Badge used at Electromagnetic Field 2024."
site_url: https://tildagon.badge.emfcamp.org
repo_url: https://github.com/emfcamp/badge-2024-documentation
theme:
  name: material
  logo: "images/badge icon_64 wide cutouts_dark.svg"
  favicon: images/favicon.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)"
      scheme: default

      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
extra_css:
  - style.css
extra_javascript:
  - index.js
markdown_extensions:
  - attr_list
  - md_in_html
  - codehilite
  - fenced_code
  - admonition
  - sane_lists
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower

plugins:
  - glightbox:
      caption_position: bottom
  - mkdocs-nav-weight
  - include-markdown
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
      minify_css: true
      cache_safe: true
  - social:
      cards_layout_options:
        background_color: "#528329"
        color: "#ffffff"
        font-family: "Roboto"
  - search
  - spellcheck:
      backends:  # the backends you want to use
      - codespell:  # or nested configs
          dictionaries: [clear, rare]

      # ignore words in <code> tags
      ignore_code: yes

      # minimum length of words to consider
      min_length: 2

      # maximum number of capital letters in a word
      max_capital: 1

      # keep unicode characters
      allow_unicode: yes

      # whether to only check in strict mode
      strict_only: no
  - git-committers:
      enabled: !ENV [CI, false]
      repository: emfcamp/badge-2024-documentation
      token: !ENV GITHUB_TOKEN
      branch: main