mkdocs.yml

site_name: Intro to UPPMAX Day 1
repo_url: https://github.com/UPPMAX/uppmax_intro_day_1
edit_uri: blob/main/docs/

nav:
  - Start: index.md
  - Learning outcomes: learning_outcomes.md
  - Prerequisites: prereqs.md
  - Course dates: course_dates.md
  - Location: location/README.md
  - Schedule: schedule.md
  - Basic use with visual tools:
      - Introduction: sessions/introduction_visual.md
      - Login in general: sessions/login.md
      - Log in to the remote desktop environment: sessions/login_remote_desktop.md
      - Use the remote desktop environment: sessions/use_remote_desktop.md
      - File transfer: sessions/file_transfer.md
  - Basic use from a terminal:
      - Introduction: sessions/introduction_terminal.md
      - Log in to the console environment: sessions/login_console.md
      - Use the terminal: sessions/use_terminal.md
  - Doing real work:
      - Introduction: sessions/introduction_real_work.md
      - The module system: sessions/modules.md
      - Creating a bash script: sessions/scripts.md
      - The job scheduler: sessions/job_scheduler.md
      - Start an interactive session: sessions/start_interactive_session.md
      - IDEs: sessions/ides.md
  - Misc:
      - About Richel: misc/richel.md
      - Acknowledgements: misc/acknowledgements.md
      - Clusters: sessions/clusters.md
      - Code of conduct: CODE_OF_CONDUCT.md
      - Contributing: CONTRIBUTING.md
      - Data: data/README.md
      - Evaluation: evaluation.md
      - Evaluations: evaluations/README.md
      - FAQ: faq/README.md
      - File transfer using scp: sessions/file_transfer_using_scp.md
      - Lesson plans: lesson_plans/README.md
      - Exercise procedure: misc/exercise_procedure.md
      - NAISS: sessions/naiss.md
      - Project: misc/project.md
      - Reflections: reflections/README.md
      - Summary: summary.md
      - The bigger picture: sessions/introduction_bigger_picture.md
      - The filesystem: sessions/filesystem.md
      - UPPMAX courses: sessions/courses.md
      - UPPMAX Intro overview: overviews/uppmax_intro.md
      - UPPMAX Intro Day 1 overview: overviews/uppmax_intro_day_1.md
  - Contact us: contact_us.md

# Replace by 'warn' in relaxed mode
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

not_in_nav: |

  communication/README.md
  communication/booking_a_room_at_bmc.md
  data/20240827/README.md
  data/20250210/README.md
  evaluations/20240827/README.md
  evaluations/20240827/anonymous_feedback.md
  evaluations/20240827/survey_feedback.md
  evaluations/20250210/README.md
  evaluations/20250825/README.md
  evaluations/20251015/README.md
  evaluations/20260119/README.md
  evaluations/20260824/README.md
  lesson_plans/20240827/README.md
  lesson_plans/20240827/20240827_richel.md
  lesson_plans/20250210/README.md
  lesson_plans/20250825/README.md
  lesson_plans/20251015/README.md
  lesson_plans/20260119/README.md
  lesson_plans/20260824/README.md
  reflections/20240827/README.md
  reflections/20250210/README.md
  reflections/20250825/README.md
  reflections/20251015/README.md
  reflections/20260119/README.md
  reflections/20260824/README.md

theme:
  name: material
  greetings: Welcome to Intro to UPPMAX Day 1
  font:
    text: Lato
    code: JetBrains Mono
  logo: assets/logo_color.png
  palette:
    primary: grey
  features:
    - toc.integrate
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.footer
    - navigation.expand
    - search.suggest
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.action.edit
    - content.action.view

markdown_extensions:
  - toc:
      toc_depth: 2
      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:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg