mkdocs.yml

---
# Project information
site_author: The GRASS Development Team  # Default author to all pages
site_name: !ENV SITE_NAME
site_url: https://grass.osgeo.org/grass-stable/manuals/

# Repository information
repo_name: GitHub
repo_url: https://github.com/OSGeo # Set to OSGeo so we can added grass and grass-addons
edit_uri_template: edit/main/{path!q}

# Project Configuration
docs_dir: source
use_directory_urls: false

# Copyright
copyright: !ENV COPYRIGHT

# Theme configuration
theme:
  name: material
  custom_dir: overrides
  language: en
  logo: grass_logo.svg
  favicon: favicon.ico
  features:
    - content.action.edit # Edit on GitHub
    - content.action.view
    - content.code.copy
    - content.tabs.link
    - search.suggest
    - search.highlight
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top

  palette:
    primary: custom
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

# Customization
extra:
  homepage: ./index.html
  social:
    - icon: simple/opencollective
      link: https://opencollective.com/grass
    - icon: fontawesome/brands/gitter
      link: https://gitter.im/grassgis/community
    - icon: fontawesome/brands/mastodon
      link: https://fosstodon.org/@grassgis/
    - icon: fontawesome/brands/discourse
      link: https://discourse.osgeo.org/c/grass/62
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/grass-gis
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/GRASSGIS
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@grass-gis

# Hooks
hooks:
  - scripts/hook_list_scripts.py

# Custom CSS
extra_css:
  - grassdocs.css

# Plugins
plugins:
  - search
  - glightbox
  - tags:
      tags_name_property: keywords
  - social:
      cards_layout_options:
        background_color: rgb(76, 176, 91)
        background_image: null

# Markdown extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.tabbed:
      alternate_style: true

# Navigation
nav:
  - Interfaces:
      - Shell:
          - Overview: grass.md
          # - Getting Started: grassintro.md # Does not exist yet
          - Environmental Variables: variables.md
      - GUI:
          - Overview: wxguiintro.md
          - Features: wxGUI.md
          - Project Management: grass_database.md
          - Tool Dialogs: wxGUI.modules.md
          - Attribute Table Management: wxGUI.dbmgr.md
          - Cartographic Composer: wxGUI.psmap.md
          - Data Catalog: wxGUI.datacatalog.md
          - Vector Digitizer: wxGUI.vdigit.md
          - Raster Digitizer: wxGUI.rdigit.md
          - Graphical Modeler: wxGUI.gmodeler.md
          - Ground Control Points Manager: wxGUI.gcp.md
          - Network Analysis: wxGUI.vnet.md
          - Help: helptext.md
          - List of Components: wxGUI.components.md

      # - Scripting:
      #     - Overview: scriptingintro.md
      #     - Python: python.md
      #     - Shell Scripting: shell.md
      #     - Batch Processing: batch.md
      #     - R: r.md
      # - Jupyter Notebook: jupyter.md

  - Project Management:
      - General Tools: general.md
      - Projection and Transformations: projectionintro.md

  - Processing Tools:
      - Raster:
          - Overview: rasterintro.md
          - Raster Tools: raster.md
      - Raster 3D:
          - Overview: raster3dintro.md
          - Raster 3D Tools: raster3d.md
      - Vectors:
          - Overview: vectorintro.md
          - Vector Tools: vector.md
          - Databases Overview: databaseintro.md
          - Database Tools: database.md
          - Supported Database Drivers: sql.md
      - Imagery:
          - Overview: imageryintro.md
          - Imagery Tools: imagery.md
          - GUI Tools:
              - Image Classification: wxGUI.iclass.md
      - Temporal:
          - Overview: temporalintro.md
          - Temporal: temporal.md

  - Visualization:
      - Display Tools: display.md
      - GUI Tools:
          - Animation: wxGUI.animation.md
          - "3D Visualization": wxGUI.nviz.md
          - Interactive Scatter Plot: wxGUI.iscatt.md
          - Map Swipe: wxGUI.mapswipe.md
          - Timeline: wxGUI.timeline.md
          - Temporal Plot: wxGUI.tplot.md

  # - Other:
  #     - Misc: miscellaneous.md
  #     - Postscript: postscript.md