mkdocs.yml

nav:
  - 前言: "index.md"
  - 自学路径: "learning-path.md"
  - 环境准备:
    - 开始之前: "getting-started/index.md"
    - 开发环境: "getting-started/environment.md"
    - 快速测试: "getting-started/test.md"
    - 波形仿真: "getting-started/simulation.md"
    - 配置合规性测试: "getting-started/compliance-test.md"
    - "配置 CoreMark 测试": "getting-started/coremark-benchmark.md"
    - 烧板验证: "getting-started/program-device.md"
    - 硬件调试: "getting-started/hardware-debug.md"
  - 预备知识:
    - 简介: "tutorial/index.md"
    - 处理器架构: "tutorial/arch.md"
    - "RV32I 指令集": "tutorial/rv32i.md"
    - 编译与链接: "tutorial/compile-and-link.md"
    - "CMake 入门": "tutorial/cmake.md"
    - 中断和异常: "tutorial/interrupt-and-exception.md"
    - 总线: "tutorial/bus.md"
  - 实验:
    - 简介: "labs/index.md"
    - "实验零 实验工具入门": "labs/lab0-getting-started.md"
    - "实验一 单周期 CPU": "labs/lab1-single-cycle-cpu.md"
    - "实验二 中断": "labs/lab2-interrupt.md"
    - "实验三 流水线 CPU": "labs/lab3-pipelined-cpu.md"
    - "实验四 总线": "labs/lab4-bus.md"
    - "挑战实验一 运行操作系统": "labs/challenge1-running-os.md"
  - FAQ: "faq/index.md"
  - 参考资料: "references/index.md"
  - 致谢: "acknowledgement/index.md"
  - 附录:
    - 简介: "appendix/index.md"
    - 开发板移植: "appendix/porting.md"

site_name: YatCPU 实验文档
site_url: https://yatcpu.sysu.tech
repo_url: https://github.com/SYSU-SCC/yatcpu-docs.git
copyright: |
  <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
theme:
  icon:
    repo: fontawesome/brands/github
  name: material
  custom_dir: docs/overrides
  language: zh
  features:
    - navigation.top
    - navigation.expand
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/weather-night
        name: 夜间模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      toggle:
        icon: material/weather-sunny
        name: 白天模式
plugins:
  - search
  - git-authors
  - git-revision-date-localized:
      type: iso_datetime
      timezone: Asia/Shanghai
markdown_extensions:
  - pymdownx.highlight
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.keys
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - footnotes
  - admonition
  - def_list
  - markdown.extensions.toc:
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
extra_css:
  - stylesheets/extra.css
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SYSU-SCC/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/sysuscc