CUIT ICEC Wiki

写在开头 🎉

欢迎参与到电协wiki的编辑中来，每个人的付出都能为电协的知识体系贡献一份力~

URL 🔗

CUIT ICEC Wiki - CUIT ICEC Wiki (gitee.io)

起步 🚀

运行环境：python 3.6+

# 配置运行环境，推荐使用 virtualenv
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
# 启动本地服务器，可在修改文章的同时实时查看渲染效果，服务器会自动重载
mkdocs serve

运行之后命令行会输出本地的预览链接，这样提交之前可以验证一下有没有一些格式错误

可能出现的问题 ❓

1.如果安装出现以下提示，需要将对应的script文件夹路径加入环境变量中

 WARNING: The script pygmentize.exe is installed in 'C:\Users\Administrator.VZMRW9ETL45BX39\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\Scripts' which is not on PATH.

新增文章 📝

将要添加至 Wiki 的 Markdown 文件保存至 docs 下的文件夹中，然后修改 mkdocs.yml 中的 nav 属性，将文章的标题及路径添加至 Wiki 目录，如：

nav:
  - 简介:
    - 首页: index.md
    - 关于: about.md
  - 硬件:
    - 电路分析: hardware/circuit_analysis.md
  - 软件:
    - C 语言: software/c_language.md

编写文章

这里我们跳转到工具来具体说下

最后

通过本地预览链接确认没有问题后，提交到服务器，服务器会进行内容的自动构建和部署