mkdocs.yml

# ------------------------------------------------------------------------------
#
# SECTION - Documentation Maintenance
#
# NOTE - Environment installation
# In Linux:
#
#   python3 -m venv venv
#   source venv/bin/activate
#   pip install mkdocs
#   pip install $(mkdocs get-deps)
#
# NOTE - Local development
# With:
#
#   mkdocs serve
#
# Docs are locally available at http://localhost:8000/mold
#
# NOTE - More information about mkdocs and mike
#   • https://www.mkdocs.org/
#   • https://squidfunk.github.io/mkdocs-material/
#   • https://pypi.org/project/mike
#
# NOTE - Publish docs
# Publish new version:
#
#   mike deploy --push --update-aliases <REL> latest
#
# Update web default version:
#
#   mike --set-default --push <REL>
#
# Keep <REL> number in sync with the mold_lib version number (see file
# alire.toml). Use only two digits, if possible.
#
# ------------------------------------------------------------------------------

site_name: Mold
site_url: https://rocher.github.io/mold
site_author: Francesc Rocher
site_description: >-
  Meta-variable Operations for Lean Development.

repo_name: rocher/mold
repo_url: https://github.com/rocher/mold
# remote_branch: main

copyright:
  Copyright &copy; - 2023-2025 Francesc Rocher

theme:
  name: material
  logo: img/star.svg
  favicon: img/favicon.ico
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # scheme: slate
    # primary: custom
  font:
    text: Noto Sans
    code: Fira Code
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.footer
    # - navigation.path
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - toc.integrate
    - toc.follow
#  highlightjs: true
#  hljs_style: xcode
#  hljs_languages:
#    - ada
#    - bash

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - meta
  - toc:
      # permalink: "¶"
      permalink: "🔗"
      permalink_title: Anchor link to this section for reference
  # PyMdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.mark
  - pymdownx.snippets:
      base_path:
        - snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic
  # - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  # - pymdownx.tilde

extra_css:
  - https://fonts.googleapis.com/css?family=Oswald:300,300i,400,400i,500,500i
  - css/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - glightbox:
      effect: none
      touchNavigation: true
      zoomable: false
      width: 80%
      draggable: false
      skip_classes:
        - skip-lightbox
  - offline
  - search
  - mike
#  - tags:
#      tags_file: tags.md

extra:
  version:
    provider: mike

# extra:
#   consent:
#     title: Cookie consent
#     description:
#       We use cookies to recognize your repeated visits and preferences, as well
#       as to measure the effectiveness of our documentation and whether users
#       find what they're searching for. With your consent, you're helping us to
#       make our documentation better.

nav:
  - HOME: index.md
  - Overview: overview.md
  - Installation: installation.md
  - User Guide: user-guide.md
  - Reference Guide: reference-guide.md
  - Examples: examples.md
  - Change Log: change-log.md
  # - Contribute: contribute.md