README.md

COMP101

本项目是 FDUCSLG COMP101 的文档项目, 用于文档的更新, 部署等.

Contribution

如果只需要进行简单的修改可以直接修改对应文档的 markdown 源码, 如果修改较为复杂请参考以下步骤.

FDUCSLG COMP101 采用 VitePress 作为文档框架, 请参考其文档进行贡献.

首先确保 node.js 版本满足 >= v20.5.0 或 >= v18.18.0, 安装好 VitePress 后, 重启终端, 于拉取的本项目根目录下执行以下代码安装依赖:

npm install

安装依赖后执行以下代码进行预览:

npm run docs:dev

Thanks

本项目文档由 NapCatQQ 项目文档 魔改而来，感谢 NapCatQQ 开发者！