mkdocs.yml

site_name: Support Documentation
repo_name: GitHub
repo_url: https://github.com/nesi/support-docs
edit_uri: edit/main/docs/
site_description: Support Documentation
site_dir: public
site_url: https://docs.nesi.org.nz/
theme:
  name: material
  custom_dir: overrides
  favicon: assets/icons/favicon_reannz.ico
  language: en
  logo: assets/icons/logo_reannz.svg
  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/lightbulb
        name: Switch to dark mode
      primary: custom
      # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.instant          # Single Page Application
    - navigation.instant.progress
    - navigation.instant.prefetch # Start loading page on link hover. Insiders only
    - navigation.top              # 'Return to top' button
    # - navigation.prune            # Reduces site size. ALSO BREAKS NAV BEHAVIOR
    - navigation.tracking         # Put anchor in URL
    - navigation.path             # Breadcrumbs. Insiders only
    - content.code.copy
    - content.action.edit
    - header.site_name_homepage
    
hooks:
  - mkdocs_hooks.py
markdown_extensions:
  - toc:
      baselevel: 1
      permalink: true
      toc_depth: 3
      title: On this page
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: txt
          class: force-wrap
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
    # auto_append:
    # - docs/assets/glossary/snippets.md  # Causes massive slowdown. Also, bad.
  - attr_list
  - abbr
  - footnotes
  - def_list
  - pymdownx.arithmatex:
      generic: true
extra:
  slurm: slurm-25.05.6
  project_code: nesi99991
  working_directory: ["/nesi/nobackup/nesi99991", "resbaz2607"]
  example_script: "sum_matrix.r"
  exercise: "https://docs.google.com/spreadsheets/d/1D5PnhE6iJOB3ZKkDCiBHnk5CNZlhmj_gS-IXKGkkVoI/edit?usp=sharing"
  status: 
  - deprecated
  - new
  - tutorial
  analytics:
    provider: google
    property: G-TVQR4R1F40
  globus_collection_storage: REANNZ Mahuika
  globus_collection_freezer: REANNZ Freezer
  globus_collection_rdc: REANNZ Research Developer Cloud (RDC)
  globus_collection_endpoint: REANNZ Data Transfer Node Tamaki
plugins:
  - mkdocs_quiz:
      disable_after_submit: false
      shuffle_answers: true
  - search
  - open-in-new-tab
  - rss:
      enabled: false
      categories:
      - tags
      - title
      json_feed_enabled: false
      pretty_print: true
      match_path: .*.md
      feed_title: Mahuika Support Docs Updates
      length: 100
      feeds_filenames:
        rss_created: page_creation.xml
        rss_updated: page_update.xml
  - redirects:
      map_file: docs/redirect_map.yml
  - awesome-nav:
      filename: .pages.yml
 # - git-authors
  - tags:
      tags: true  # This will keep tags for the purpose of indexing, but not display on page.
  - git-revision-date-localized:
      enable_creation_date: false
      enabled: !ENV [ENABLED_GIT_DATES, false]
  - macros:
      on_error_fail: false
      verbose: true
      module_name: macro_hooks
      include_dir: overrides
  - llmstxt:
      markdown_description: >-
        NeSI Mahuika HPC support documentation: getting access, running batch jobs
        with Slurm, available software and modules, storage and data transfer,
        interactive computing (Jupyter, OnDemand), and platform policies.
      # These are fnmatch patterns, not pathlib globs - `*` already crosses `/`, so
      # `Section/*.md` matches every page at any depth. Do NOT "fix" these to `**`:
      # `Section/**/*.md` requires a literal extra `/`, which silently drops every page
      # sitting directly in the section directory (it emptied Batch Computing and Policy).
      # mkdocs_hooks.on_config rewrites these globs into explicit per-page entries so each
      # link carries its front matter `description`.
      sections:
        Announcements:
          - Announcements/*.md
        Getting Started:
          - Getting_Started/*.md
        Software:
          - Software/*.md
        Batch Computing:
          - Batch_Computing/*.md
        Interactive Computing:
          - Interactive_Computing/*.md
        Storage:
          - Storage/*.md
        Data Transfer:
          - Data_Transfer/*.md
        Policy:
          - Policy/*.md
        Service Subscriptions:
          - Service_Subscriptions/*.md
        Tutorials:
          - Tutorials/*.md
        Reference:
          - GLOSSARY.md
          - index.md
extra_css:
  - assets/stylesheets/theme.css
  - assets/stylesheets/chat.css
extra_javascript:
    - https://cdnjs.cloudflare.com/ajax/libs/ical.js/1.3.0/ical.min.js
    - https://status.nesi.org.nz/embed/script.js
    - assets/javascripts/mathjax.js
    - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
    - assets/javascripts/general.js
    - assets/javascripts/chat.js
    - assets/javascripts/supportedApplications.js