mkdocs.yml

site_name: Bianca workshop

repo_url: https://github.com/UPPMAX/bianca_workshop
edit_uri: blob/main/docs/

nav:
  - Home: index.md
  - Practicalities: practicalities.md
  - Bianca intro (beginner): 
    - Introduction: intro.md
    - Login: login.md
    - Log in to the Bianca remote desktop environment: login_remote_desktop.md
    - Using the desktop environment: use_remote_desktop.md
    - Log in to the Bianca console environment: login_console.md
    - Command-line intro: commandline.md
    - Create an exectable script: create_script.md
    - Module system: modules.md
    - Transferring files to/from Bianca: transfer_basics.md
    - Transferring files to/from Bianca using a GUI: file_transfer_using_gui.md
    - Introduction to compute nodes: slurm_intro.md
    - Intro to NAISS-SENS and sensitive data: sens_project_short.md
    - Summary: summary.md
    - Evaluation: evaluation.md
  - Intermediate workshop/hackaton: 
    - Introduction: intermediate/intro.md
    - Prevaluation: intermediate/prevaluation_intermediate.md
    - Transferring files to/from Bianca: intermediate/transfer.md
    - Efficient jobs: intermediate/efficient_jobs.md
    - Complex jobs: intermediate/complex_jobs.md
    - Replicate jobs: intermediate/replicate_jobs.md
    - Software and package installation: intermediate/install.md
    - IDEs: intermediate/ides.md
    - Summary: intermediate/summary.md
    - Evaluation: intermediate/evaluation_intermediate.md
  - Extra material:
    - Overview: intermediate/overview.md
    - extra/slurm.md
    - extra/source_install.md
    - extra/conda.md
    - extra/pip.md
    - extra/rpackages.md
    - extra/julia.md
    - extra/containers.md
    - extra/devel.md
  - Misc: 
      - Project: misc/project.md
      - Shared document: misc/shared_document.md
      - Exercise procedure: misc/exercise_procedure.md
 
theme:
  name: material
  greetings: Welcome to Bianca workshop
  font:
    text: Lato
    code: JetBrains Mono

  logo: assets/logo.svg

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.footer
    - search.suggest
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - content.action.view

  custom_dir: mkdocs_uppmax/
    
extra_css:
  - stylesheets/extra.css


markdown_extensions:
  - toc:
      toc_depth: 3
      permalink: true
      permalink_title: Anchor link to this section for reference
  - admonition
  - tables
  - attr_list
  - footnotes
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.keys
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde