mkdocs.yml

# This file uses the following environment variables set within the build workflow:
# - SITE_URL: the URL of the site (Falls back to the default URL)
# For example, for PR-previews, SITE_URL is set to <default_URL>/pr-preview-NUM
site_name: ACCESS-ESM1.6-Configs

# Site URL
site_url: !ENV READTHEDOCS_CANONICAL_URL

# Git repository (Adds a link to the GitHub repository at the top)
repo_url: https://github.com/ACCESS-NRI/access-esm1.6-configs
repo_name: ACCESS-NRI/access-esm1.6-configs
edit_uri: blob/main/documentation/docs/ #hopefully will fix the edit button from 404'ing, https://github.com/mkdocs/mkdocs/issues/2416
 
# Theme
theme:
  name: material
  custom_dir: overrides
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: custom-light
      primary: none
      accent: none
      toggle:
        icon: material/theme-light-dark
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: none
      accent: none
      scheme: custom-dark
      toggle:
        icon: material/theme-light-dark
        name: Switch to light mode

  features:
    - content.action.edit       # if works, will turn on the "edit on GitHub feature" https://github.com/squidfunk/mkdocs-material/issues/5261
    - navigation.instant
    - navigation.tracking       # The URL in the address bar is automatically updated with active anchor
    - navigation.indexes
    # - navigation.tabs         # Tabs at the top
    # - navigation.tabs.sticky
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy         # for displaying copy icon at top right in code snippets
    - toc.follow                # the sidebar is automatically scrolled to the active anchor

  logo: assets/ACCESS_icon_HIVE.png
  favicon: assets/ACCESS_icon_HIVE.png
  icon:
    edit: material/pencil
    view: material/eye
copyright: Copyright &copy; 2025 ACCESS-NRI, CSIRO and contributors

plugins:
  - git-revision-date-localized:
      type: date
      enable_creation_date: false
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - macros
  - bibtex:
      bib_file: references.bib
      csl_file: https://raw.githubusercontent.com/citation-style-language/styles/26eccff9e537f71494a4da7b91afac1adf571dc9/apa.csl
  - events:
      events_dir: community_resources/events/events

markdown_extensions: 
  - attr_list
  - abbr
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.snippets
  - pymdownx.highlight
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.keys
  - pymdownx.arithmatex:
      generic: true
  - def_list
  - footnotes
  - tables
  - toc:
      title: On this page
      permalink: true

# Navigation
nav:
  - Home:                            pages/index.md
  - Contributing:          
        - Contributing overview:     pages/contributing/index.md   
  - Model Components:
        - MOM - Ocean:      pages/model_components/mom.md
        - WOMBAT - Ocean Biogeochem.:   pages/model_components/wombat.md
        - CICE - Sea Ice:     pages/model_components/cice.md
        - UM - Atmosphere:       pages/model_components/um.md
        - CABLE - Land:    pages/model_components/cable.md
        - CASA - Land Biogeochem.:     pages/model_components/casa.md
  - Inputs:
        - Ocean:    pages/inputs/ocean.md
        - Sea ice:    pages/inputs/seaice.md
        - Atmosphere:    pages/inputs/atmosphere.md
        - Land:    pages/inputs/land.md
        - Restarts: pages/inputs/restarts.md

  - Configurations and Experiments:
        - Configuration:    pages/configs_experiments/overviewconfiguration.md
        - Experiments:    pages/configs_experiments/experiments.md

  - Diagnostics:        pages/diagnostics/index.md
  - Infrastructure:    
        - Architecture:          pages/infrastructure/Architecture.md
        - Building:              pages/infrastructure/Building.md
        - Git practices:         pages/infrastructure/Git-practices.md

# Footer
extra:
  generator: false
  social:
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/access-nri.bsky.social
      name: ACCESS-NRI on Bluesky
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/access-nri
      name: ACCESS-NRI on Linkedin

extra_css:
  - "https://fonts.googleapis.com/icon?family=Material+Icons"   # Material Icons Reference - https://material.io/resources/icons/?style=baseline
  - "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.0/css/all.min.css"
  - fontello/css/fontello-codes.css
  - fontello/css/fontello-ie7-codes.css
  - fontello/css/fontello-ie7.css
  - fontello/css/fontello.css
  - css/custom.css

extra_javascript:
  - javascripts/mathjax.js # For pymdownx.arithmatex extension
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js # For pymdownx.arithmatex extension
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js     # For tablesort functionality 
  - https://cdn.jsdelivr.net/gh/atteggiani/animated-terminal@3.0/animated-terminal.min.js # Terminal animations
  # - js/custom-tags.js
  # - js/miscellaneous.js

# Automatically reload page when running `mkdocs serve`, for any 
# of the following files outside of the 'docs' directory
watch:
  - mkdocs.yml
  - overrides/

hooks:
  - hooks/hide_pages_url_segment.py