Merge branch 'master' of https://github.com/2023wyh/SDNURoboticsAILab…

….github.io

.github/workflows/deploy-test.yml

@@ -0,0 +1,42 @@
+name: Deploy Test
+
+on:
+  pull_request:
+    branches: [master]
+
+jobs:
+
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+
+    - name: Cache dependencies
+      uses: actions/cache@v3
+      with:
+        key: mkdocs-material-${{ runner.os }}-${{ hashFiles('**/requirements.txt') }}
+        path: .cache
+
+    - name: Install dependencies
+      run: |
+        pip3 install -U -r requirements.txt
+
+    - name: Build site
+      run: mkdocs build
+
+    - name: Check Deployment
+      run: |
+        if [ -d "site" ]; then
+          echo "Deploy would have succeeded!"
+        else
+          echo "Deploy would have failed!"
+          exit 1
+        fi
+      env:
+          GH_TOKEN: ${{ secrets.GH_PAT }}

.gitignore

@@ -1,3 +1,13 @@
+# editor and system files
+.DS_Store
+.editorconfig
 .history
 .vscode
-.DS_Store
+# dependence
+node_modules/
+# build
+dist/
+build/
+# log
+npm-debug.log
+yarn-error.log

README-zh.md

@@ -18,15 +18,21 @@
 mkdocs serve
 ```
 
-进行测试。
+进行本地服务器测试，或者使用
+
+```bash
+mkdocs build
+```
+
+检查生成的静态页面。
 
 本仓库采用 [commitlint](https://github.com/conventional-changelog/commitlint) + [husky](https://github.com/typicode/husky) 的方案自动进行 `commit message` 的审查，请确保 `commit message` 符合 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范。但也不必过多担心，本仓库已集成 [Commitizen](https://github.com/commitizen/cz-cli) 协助填写 `commit message` 。具体包及版本见 [package.json](package.json) ，在首次 `commit` 前请使用
 
 ```bash
 npm install
 ```
 
-安装所有依赖。
+安装所有依赖，安装成功后可使用 `git cz` 替代 `git commit` 。
 
 若进行修改的是页面，请尽量确保文档遵守 [Markdown Rules](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md) 与 [Markdown 简体中文与西文混排要点](https://github.com/selfteaching/markdown-writing-with-mixed-cn-en)，并且不要忘记修改 [mkdocs.yml](mkdocs.yml) 的 `nav` 部分。
 
@@ -37,3 +43,4 @@ npm install
 ## 待办事项
 
 - 完善各个页面
+- 使每个页面显示页面最后修改时间而不是现在的仓库修改时间

README.md

@@ -18,15 +18,21 @@ If you have any content you want to add, correct, or delete on this site, you ar
 mkdocs serve
 ```
 
-to test it first.
+to test it on local server, or use
+
+```bash
+mkdocs build
+```
+
+to check the generated static pages.
 
 This repository uses the [commitlint](https://github.com/conventional-changelog/commitlint) + [husky](https://github.com/typicode/husky) solution to automatically review `commit messages`. Please ensure that your `commit messages` conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. However, don't worry too much, as this repository has integrated [Commitizen](https://github.com/commitizen/cz-cli) to assist in writing `commit messages`. For specific packages and versions, see [package.json](package.json). Before first committing, please use
 
 ```bash
 npm install
 ```
 
-to install all dependencies.
+to install all dependencies. After successful installation, you can use `git cz` instead of `git commit`.
 
 If you are modifying a page, please ensure that the document complies with [Markdown Rules](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md) and [Markdown Writing with Mixed Chinese and English](https://github.com/selfteaching/markdown-writing-with-mixed-cn-en). Also, don't forget to update the `nav` section of [mkdocs.yml](mkdocs.yml).
 
@@ -37,3 +43,4 @@ If the pages you submit contain images, please use [this image bed](https://gith
 ## To-Do List
 
 - Improve each page
+- Make each page display the last modification time of the page instead of the current repository modification time