This project is currently deployed on GitHub Pages using MkDocs and the Material Theme.
To deploy locally, you need a Python3
environment, and the required packages can be found in requirements.txt
.
The site has automatic deployment in place, so there is no need to build static pages locally before pushing.
If you have any content you want to add, correct, or delete on this site, you are welcome to submit a Pull Request.
If you are modifying a page, please ensure that the document complies with Markdown Rules and Markdown Writing with Mixed Chinese and English. Also, don't forget to update the nav
section of mkdocs.yml
.
This site supports both Chinese and English. Unless this feature is abandoned after discussion, please ensure that each page has at least two Markdown
files: page.md
and page.en.md
, and remember to add them to the nav_translations
section of the i18n
plugin in mkdocs.yml
.
If the pages you submit contain images, please use this image bed. It is recommended to use the PicGo + Typora method.
- Improve each page