mkdocs.yml

# 项目设置
site_name: HPC101 (2025)
site_url: https://hpc101.zjusct.io/
repo_url: https://github.com/ZJUSCT/HPC101
repo_name: ZJUSCT/HPC101
edit_uri: blob/main/docs/
site_description: 浙江大学计算机学院暑期课程 HPC101 实验网站
site_author: ZJUSCT
copyright: ZJUSCT

nav:
  # 已启用 include_dir_to_nav 插件，可使用目录名导航
  - 课程信息:
    - index.md
    - 使用集群: guide
  - 课程实验:
    - "Lab 0: Linux 快速入门": lab/Lab0-LinuxCrashCourse/index.md
    - "Lab 1: 简单集群搭建": lab/Lab1-MiniCluster/index.md
    - "Lab 2: 向量化计算": lab/Lab2-Vectorization/index.md
    - "Lab 2.5: 向量化进阶 (RISC-V)": lab/Lab2.5-RISC-V/index.md
    - "Lab 3: CUDA 卷积": lab/Lab3-CudaConv/index.md
    - "Lab 4: Solver Challenge": lab/Lab4-Solver-Challenge/index.md
    - "Final Project - 大作业": lab/Final-Project/index.md
  - 课程幻灯片: slides/index.md

theme:
  name: material
  logo: assets/zjusct.svg
  favicon: assets/zjusct-hpc101.svg
  palette:
    - media: "(prefers-color-scheme)"
      primary: pink
      toggle:
        icon: material/brightness-auto
        name: 切换至浅色模式
    - media: "(prefers-color-scheme: light)"
      scheme: zjusct
      toggle:
        icon: material/brightness-7
        name: 切换至深色模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: 根据系统模式切换主题
  features:
    # 代码块操作
    - content.code.copy
    - content.code.select
    - content.code.annotate
    # 底部导航
    - navigation.footer
    # 顶部导航
    - navigation.tabs
    # 侧边栏按 section 展开
    - navigation.sections
    - navigation.expand
    # 章节首页 index.md
    # - navigation.indexes
    # 锚点
    - navigation.tracking
    # 路径
    - navigation.path
    # 回到顶部
    - navigation.top
    - toc.follow
    # 页面编辑
    - content.action.edit
    # 搜索
    - search.suggest
    - search.highlight
    - search.share

markdown_extensions:
  # Admonition
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      # Mermaid
      custom_fences:
        - name: mermaid
          class: mermaid
          format:
            !!python/name:pymdownx.superfences.fence_code_format # Code Block
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  # Tab Card
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  # Grid, Image
  - attr_list
  - md_in_html
  # Icon
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg # List
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  # TOC
  - toc:
      permalink: true
      # 中文锚点
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  # MathJax
  - pymdownx.arithmatex:
      generic: true
  # Keys
  - pymdownx.keys
  # Highlight
  - pymdownx.critic
  # 时间轴、甘特图
  - neoteroi.timeline
  - neoteroi.projects
  - neoteroi.cards

extra_javascript:
  # MathJax
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/polyfill/index.min.js
  - https://cdn.jsdelivr.net/npm/mathjax/es5/tex-mml-chtml.js
  # Table Sort
  - https://cdn.jsdelivr.net/npm/tablesort/dist/tablesort.min.js
  - javascripts/tablesort.js
  # mermaid
  - https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js

extra_css:
  - stylesheets/fonts.css
  - stylesheets/counter.css
  - stylesheets/theme.css
  # neoteroi
  - stylesheets/neoteroi-v1.1.2.css

plugins:
  - git-revision-date-localized:
      enable_creation_date: true
  # 该插件本地编辑时关闭，CI 时自动开启
  - git-committers:
      enabled: false
      repository: zjusct/hpc101
      branch: main
  - glightbox
  - drawio
  - tags
  - search
  - include_dir_to_nav:
      recurse: false