From 56d970f19170ca21d7f43df7da4c037c758b9c0e Mon Sep 17 00:00:00 2001 From: PurplePower <60787289+PurplePower@users.noreply.github.com> Date: Mon, 25 Aug 2025 22:26:51 +0800 Subject: [PATCH 1/7] Create ci.yml --- .github/workflow/ci.yml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflow/ci.yml diff --git a/.github/workflow/ci.yml b/.github/workflow/ci.yml new file mode 100644 index 0000000..7508c2f --- /dev/null +++ b/.github/workflow/ci.yml @@ -0,0 +1,30 @@ +name: ci +on: + push: + branches: + - master + - main + - docs +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: ~/.cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force \ No newline at end of file From a8169199f9665e089fc9537ce218a1e0d2cba5f1 Mon Sep 17 00:00:00 2001 From: PurplePower <60787289+PurplePower@users.noreply.github.com> Date: Mon, 25 Aug 2025 22:41:04 +0800 Subject: [PATCH 2/7] Update ci.yml --- .github/workflow/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflow/ci.yml b/.github/workflow/ci.yml index 7508c2f..2ab37a2 100644 --- a/.github/workflow/ci.yml +++ b/.github/workflow/ci.yml @@ -27,4 +27,5 @@ jobs: restore-keys: | mkdocs-material- - run: pip install mkdocs-material + - run: cd docs - run: mkdocs gh-deploy --force \ No newline at end of file From f89a80cb0dbda2a523c7d675efacc29fa212d393 Mon Sep 17 00:00:00 2001 From: PurplePower <60787289+PurplePower@users.noreply.github.com> Date: Mon, 25 Aug 2025 23:12:57 +0800 Subject: [PATCH 3/7] Update mkdocs.yml --- docs/mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e6ea344..bcabf92 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -52,7 +52,7 @@ theme: - content.tabs.link - navigation.expand - +use_directory_urls: false markdown_extensions: - toc: permalink: "🚁" From 1bcbf27c82ad00ed6a4a69b712538feb25f264d8 Mon Sep 17 00:00:00 2001 From: PurplePower <60787289+PurplePower@users.noreply.github.com> Date: Tue, 26 Aug 2025 14:41:31 +0800 Subject: [PATCH 4/7] Move mkdocs.yml to project root and update paths Relocated mkdocs.yml from docs/ to the project root and updated all navigation paths. --- docs/mkdocs.yml | 77 ------------------------------------------------- mkdocs.yml | 77 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 77 deletions(-) delete mode 100644 docs/mkdocs.yml create mode 100644 mkdocs.yml diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index bcabf92..0000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -1,77 +0,0 @@ -site_name: 2023-Yatcpu-Fall-Docs -site_author: Tokisakix -copyright: Copyright © 2023 Tokisakix - -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 - -use_directory_urls: false -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 - -plugins: - - glightbox: - zoomable: true - width: 100% \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..5d13aea --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,77 @@ +site_name: 2023-Yatcpu-Fall-Docs +site_author: Tokisakix +copyright: Copyright © 2023 Tokisakix + +nav: +- 前言: index.md + + +- 最终验收: test.md +- docs/better-tut/intro.md +- 实验环境配置: + - docs/better-tut/getting-started/index.md + - docs/better-tut/getting-started/windows.md + - docs/better-tut/getting-started/linux-wsl.md + - docs/better-tut/getting-started/macos.md + # - docs/better-tut/getting-started/docker.md + - 一键配置 docker 环境: env.md + +- 基础工程知识与技能: + - docs/better-tut/practice/envvar-and-cmd.md + - docs/better-tut/practice/scala-and-chisel.md + - docs/better-tut/practice/chisel-test.md + - docs/better-tut/practice/simulation.md + - docs/better-tut/practice/compliance-test.md + - docs/better-tut/practice/coremark-benchmark.md + - docs/better-tut/practice/program-device.md + - docs/better-tut/practice/hardware-debug.md + - docs/better-tut/practice/compile-and-link.md + - docs/better-tut/practice/cmake.md + - 如何一键烧板: board.md + +- 理论知识基础: + - docs/better-tut/theory/cpu-arch.md + - docs/better-tut/theory/riscv-isa.md + - docs/better-tut/theory/interrupt-and-exception.md + - docs/better-tut/theory/bus.md +- 实验: + - docs/better-tut/labs/lab1/lab1-single-cycle-cpu.md + - docs/better-tut/labs/lab2/lab2-interrupt.md + - docs/better-tut/labs/lab3/lab3-pipelined-cpu.md + - docs/better-tut/labs/lab4/lab4-bus.md + - docs/better-tut/labs/challenge1/challenge1-running-os.md +- 快速参考资料: + - docs/better-tut/cheatsheets/riscv-isa.md + - docs/better-tut/cheatsheets/ide-tips.md +- docs/references.md +- docs/acknowledgement.md + +theme: + name: material + features: + - content.tabs.link + - navigation.expand + +use_directory_urls: false +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 + +plugins: + - glightbox: + zoomable: true + width: 100% \ No newline at end of file From c80243d7843d002030cc3b80ee8a92be3395ef10 Mon Sep 17 00:00:00 2001 From: PurplePower <60787289+PurplePower@users.noreply.github.com> Date: Tue, 26 Aug 2025 14:47:42 +0800 Subject: [PATCH 5/7] Update mkdocs.yml --- mkdocs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5d13aea..005f0f9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,12 +1,12 @@ -site_name: 2023-Yatcpu-Fall-Docs +site_name: 2025-Yatcpu-Fall-Docs site_author: Tokisakix copyright: Copyright © 2023 Tokisakix nav: -- 前言: index.md +- 前言: docs/index.md -- 最终验收: test.md +- 最终验收: docs/test.md - docs/better-tut/intro.md - 实验环境配置: - docs/better-tut/getting-started/index.md @@ -14,7 +14,7 @@ nav: - docs/better-tut/getting-started/linux-wsl.md - docs/better-tut/getting-started/macos.md # - docs/better-tut/getting-started/docker.md - - 一键配置 docker 环境: env.md + - 一键配置 docker 环境: docs/env.md - 基础工程知识与技能: - docs/better-tut/practice/envvar-and-cmd.md From 135cecdc6a1960b5954fc74408ab931361652314 Mon Sep 17 00:00:00 2001 From: PurplePower <60787289+PurplePower@users.noreply.github.com> Date: Tue, 26 Aug 2025 15:08:33 +0800 Subject: [PATCH 6/7] Update .gitignore and mkdocs.yml config Added site directory to .gitignore for GitHub Pages output. Adjusted mkdocs.yml formatting and moved use_directory_urls to the top for improved clarity. --- .gitignore | 3 +++ mkdocs.yml | 5 ++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 3edf322..49fde9c 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,6 @@ target # misc/lab*_ans.yaml + +# github pages +site/**/* diff --git a/mkdocs.yml b/mkdocs.yml index 005f0f9..8c672e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,11 +1,10 @@ site_name: 2025-Yatcpu-Fall-Docs site_author: Tokisakix copyright: Copyright © 2023 Tokisakix +use_directory_urls: false nav: - 前言: docs/index.md - - - 最终验收: docs/test.md - docs/better-tut/intro.md - 实验环境配置: @@ -52,7 +51,7 @@ theme: - content.tabs.link - navigation.expand -use_directory_urls: false + markdown_extensions: - toc: permalink: "🚁" From 34dd34593833ba6677c8cd55f13bc638ed5b75af Mon Sep 17 00:00:00 2001 From: PurplePower <60787289+PurplePower@users.noreply.github.com> Date: Tue, 26 Aug 2025 15:21:20 +0800 Subject: [PATCH 7/7] Rename CI workflow file and update docs requirements Moved the CI workflow file to the correct '.github/workflows' directory. Added 'mkdocs-glightbox==0.40' to docs/requirements.txt for documentation enhancements. --- .github/{workflow => workflows}/ci.yml | 0 docs/requirements.txt | 3 ++- 2 files changed, 2 insertions(+), 1 deletion(-) rename .github/{workflow => workflows}/ci.yml (100%) diff --git a/.github/workflow/ci.yml b/.github/workflows/ci.yml similarity index 100% rename from .github/workflow/ci.yml rename to .github/workflows/ci.yml diff --git a/docs/requirements.txt b/docs/requirements.txt index 86de9ec..39068a3 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,5 @@ mkdocs mkdocs-material mkdocs-material-extensions mkdocs-git-revision-date-localized-plugin==0.9.2 -mkdocs-git-authors-plugin==0.3.3 \ No newline at end of file +mkdocs-git-authors-plugin==0.3.3 +mkdocs-glightbox==0.40 \ No newline at end of file