diff --git a/.github/workflows/mkdocs-build.yml b/.github/workflows/mkdocs-build.yml index f9258f4..7a5a163 100644 --- a/.github/workflows/mkdocs-build.yml +++ b/.github/workflows/mkdocs-build.yml @@ -26,4 +26,4 @@ jobs: restore-keys: | mkdocs-material- - run: pip install -r ./docs/requirements.txt - - run: mkdocs gh-deploy --force + - run: cd docs; mkdocs gh-deploy --force diff --git a/docs/docs/better-tut/practice/scala-and-chisel.md b/docs/docs/better-tut/practice/scala-and-chisel.md index 9552137..bec0b65 100644 --- a/docs/docs/better-tut/practice/scala-and-chisel.md +++ b/docs/docs/better-tut/practice/scala-and-chisel.md @@ -1,6 +1,6 @@ # Scala 和 Chisel 编程语言 -Writen By: [Howard Lau], [Tiger9Tu], [PurplePower](https://github.com/PurplePower) +Writen By: [Howard Lau](https://github.com/howardlau1999), [Tiger9Tu](), [PurplePower](https://github.com/PurplePower) > 工欲善其事,必先利其器。 diff --git a/mkdocs.yml b/docs/mkdocs.1.yml.backup similarity index 100% rename from mkdocs.yml rename to docs/mkdocs.1.yml.backup diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..af58f53 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,82 @@ +site_name: 2025-Yatcpu-Fall-Docs +site_author: Tokisakix +copyright: Copyright © 2023 Tokisakix +site_url: https://purplepower.github.io/2025-fall-yatcpu-repo/ +use_directory_urls: false + +nav: +- 前言: index.md +- 最终验收: test.md +- better-tut/intro.md +- 实验环境配置: + - better-tut/getting-started/index.md + - better-tut/getting-started/windows.md + - better-tut/getting-started/linux-wsl.md + - better-tut/getting-started/macos.md + # - better-tut/getting-started/docker.md + - 一键配置 docker 环境: env.md + +- 基础工程知识与技能: + - better-tut/practice/envvar-and-cmd.md + - better-tut/practice/scala-and-chisel.md + - better-tut/practice/chisel-test.md + - better-tut/practice/simulation.md + - better-tut/practice/compliance-test.md + - better-tut/practice/coremark-benchmark.md + - better-tut/practice/program-device.md + - better-tut/practice/hardware-debug.md + - better-tut/practice/compile-and-link.md + - better-tut/practice/cmake.md + - 如何一键烧板: board.md + +- 理论知识基础: + - better-tut/theory/cpu-arch.md + - better-tut/theory/riscv-isa.md + - better-tut/theory/interrupt-and-exception.md + - better-tut/theory/bus.md +- 实验: + - better-tut/labs/lab1/lab1-single-cycle-cpu.md + - better-tut/labs/lab2/lab2-interrupt.md + - better-tut/labs/lab3/lab3-pipelined-cpu.md + - better-tut/labs/lab4/lab4-bus.md + - better-tut/labs/challenge1/challenge1-running-os.md +- 快速参考资料: + - better-tut/cheatsheets/riscv-isa.md + - better-tut/cheatsheets/ide-tips.md +- references.md +- acknowledgement.md + +theme: + name: material + features: + - content.tabs.link + - navigation.expand + + +markdown_extensions: + - toc: + permalink: "🚁" + - pymdownx.superfences + - admonition + - footnotes + - pymdownx.details + - pymdownx.tabbed: + alternate_style: true + - attr_list + - md_in_html + - pymdownx.blocks.caption + - tables + - def_list + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.keys + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + +plugins: + - glightbox: + zoomable: true + width: 100% + +