mkdocs.yml

site_name: GRIMdata
site_description: Global Rights Information Monitoring - Research platform hosting human rights data analysis projects including LittleRainbowRights and SGBV-UPR with REST API
site_author: GRIMdata Project
site_url: https://grimdata.org

# Repository
# Note: Site is built from DigitalChild repo (LittleRainbowRights project)
# SGBV-UPR has separate repo: github.com/MissCrispenCakes/HumanRights
repo_name: MissCrispenCakes/DigitalChild
repo_url: https://github.com/MissCrispenCakes/DigitalChild
edit_uri: edit/basecamp/docs/

# Copyright
copyright: |
  &copy; 2026 GRIMdata<br>
  LittleRainbowRights: <a href="https://github.com/MissCrispenCakes/DigitalChild">DigitalChild repo</a> |
  SGBV-UPR: <a href="https://github.com/MissCrispenCakes/HumanRights">HumanRights repo</a> (private - under construction - a broken laptop is to blame :sweat_smile:)

# Theme
theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: pink
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    # Disabled: Too aggressive, causes slowness
    # - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    # Disabled: Can conflict with toc.integrate
    # - navigation.indexes
    - navigation.footer
    - toc.follow
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.tabs.link
    - announce.dismiss
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    logo: material/book-open-page-variant

# Plugins
plugins:
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - tags

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - 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

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/MissCrispenCakes/DigitalChild
      name: GitHub Repository
    - icon: fontawesome/solid/globe
      link: https://littlerainbowrights.com
      name: LittleRainbowRights
  # analytics:  # Uncomment and add Google Analytics ID if desired
  #   provider: google
  #   property: G-XXXXXXXXXX
  alternate:
    - name: English
      link: /
      lang: en

# Navigation
nav:
  - GRIMdata Home: website/index.md

  - Getting Started:
      - Installation: website/getting-started/installation.md
      - Quick Start: website/getting-started/quickstart.md
      - First Run Errors: guides/FIRST_RUN_ERRORS.md
      - FAQ: FAQ.md

  - API:
      - Overview: api/index.md
      - Quick Start: api/quickstart.md
      - Full Documentation: api/reference.md
      - Quick Reference: api/quick-reference.md

  - Scorecard:
      - Overview: scorecard/index.md
      - Design & Methodology: scorecard/design.md
      - Data Access: scorecard/data-access.md
      - Visualization: scorecard/visualization.md
      - Data Explorer: scorecard/explorer.md

  - Projects:
      - Overview: website/projects/index.md
      - LittleRainbowRights:
          - Project Overview: website/projects/littlerainbowrights/index.md
          - User Guides:
              - Runbook: guides/RUNBOOK.md
              - Scorecard Workflow: guides/SCORECARD_WORKFLOW.md
              - Validators Usage: guides/VALIDATORS_USAGE.md
              - Production Deployment: guides/PRODUCTION_DEPLOYMENT.md
          - Documentation:
              - Architecture: ARCHITECTURE.md
              - Glossary: GLOSSARY.md
              - Data Governance: DATA_GOVERNANCE.md
              - Docs Index: DOCS_INDEX.md
          - Development:
              - Roadmap: ROADMAP.md
              - Standards:
                  - Metadata Schema: standards/METADATA_SCHEMA.md
                  - File Naming: standards/FILE_NAMING_STANDARDS.md
                  - Document Types: standards/DOC_TYPE_STANDARDS.md
                  - Scraper Structure: standards/SCRAPER_STRUCTURE.md
                  - Tags Config: standards/TAGS_CONFIG_FORMAT.md
                  - Recommendations Config: standards/RECOMMENDATIONS_CONFIG_FORMAT.md
                  - Comparison Config: standards/COMPARISON_CONFIG_FORMAT.md
                  - Filters Config: standards/FILTERS_CONFIG_FORMAT.md
                  - ISO Mapping: standards/ISO_MAPPING.md
              - Notes:
                  - Directory Structure: notes/DIRECTORY_STRUCTURE.md
                  - Pipeline Flow: notes/PIPELINE_FLOW.md
                  - Pipeline Logging: notes/PIPELINE_LOGGING.md
                  - Tags Main Notes: notes/TAGS_MAIN_NOTES.md
                  - Tags Export Notes: notes/TAGS_EXPORT_NOTES.md
                  - Comparison Export Notes: notes/COMPARISON_EXPORT_NOTES.md
              - Planning:
                  - Source Feasibility: planning/SOURCE_FEASIBILITY_CHECKLIST.md
                  - Tags Visualization: planning/TAGS_VISUALIZATION_PLAN.md
              - Reviews:
                  - Scorecard Review: reviews/SCORECARD_REVIEW_SUMMARY.md
                  - Processor Tests: reviews/PROCESSOR_TEST_RUN.md
      - SGBV-UPR:
          - Project Overview: website/projects/sgbv/index.md

  - About:
      - Research Context: RESEARCH_CONTEXT.md
      - Contributing: CONTRIBUTING.md

# Custom CSS
extra_css:
  - website/stylesheets/extra.css

# Custom JavaScript
extra_javascript:
  - website/javascripts/extra.js
  # Plotly removed from global load - will be loaded conditionally by extra.js on scorecard pages only
  # This saves 2.27MB on every page load!