mkdocs.yml

site_name: CANFAR Science Platform
site_url: https://opencadc.github.io/science-containers/
site_author: CANFAR
site_description: Documentation and Science Containers for the CANFAR Science Platform
repo_url: https://github.com/opencadc/science-containers/
repo_name: opencadc/science-containers
edit_uri: blob/main/docs/
copyright: Copyright © 2023 CANFAR
remote_branch: gh-pages

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  language: en
  icon:
    repo: fontawesome/brands/github-alt
    edit: material/pencil-box
    view: material/eye-outline
  features:
    - tabs
    - instant
    - content.action.edit
    - offline
    - navigation.sections
    #- navigation.expand

plugins:
  - search
  - mkdocstrings
  - git-revision-date-localized:
        type: date
        fallback_to_build_date: true

# Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      linenums_style: pymdownx.inline
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Introduction and Access:
    - complete/index.md
  - General User Documentation:
    - general/index.md
    - New User Documentation:
      - general/NewUser/Overview.md
      - Login: general/NewUser/Login.md
      - Project Space: general/NewUser/ProjectSpace.md
      - Launch Desktop: general/NewUser/LaunchDesktop.md
      - Launch CARTA: general/NewUser/LaunchCARTA.md
      - Launch Notebook: general/NewUser/LaunchNotebook.md
    - In-Depth Documentation:
      - Publishing Containers: complete/publishing.md
      - Permissions: complete/permissions.md
      - CANFAR Containers: complete/science-containers.md
      - Headless: complete/headless.md
      - Infrastructure: complete/science-platform.md
      - Portal: complete/science-portal.md
  - Tutorials and Help:
    - General Tutorials:
      - File Transfers: general/General_tools/File_transfers
      - Using Web Storage: general/General_tools/Using_webstorage
      - Using vostools: general/General_tools/Using_vostools
      - Using sshfs: general/General_tools/Using_sshfs
      - Group Management: general/General_tools/Group_management
      - Transfering to Notebooks: general/Notebook/transfer_file
    - Tips and Tricks:
      - Using the desktop clipboard: general/TipsTricks/Using_clipboard
      - Increasing desktop font : general/TipsTricks/Increase_font
      - URL upload/download: general/TipsTricks/Direct_url
    - ALMA Tutorials (Desktop Sessions):
      - Starting CASA: general/ALMA_Desktop/start_casa
      - Downloading from the ALMA archive (browser): general/ALMA_Desktop/archive_download
      - Downloading from the ALMA archive (script): general/ALMA_Desktop/archive_script_download
      - Example of reducing image data: general/ALMA_Desktop/typical_reduction
  - FAQ: complete/faq.md