一个开源的 OI 在线工具箱去快速开始你的编码!
开始使用 »
提交贡献
·
报告 Bug
·
提出新特性
本项目目前采用 MkDocs 及其主题 Material for MkDocs 进行渲染。
当然,也可以在本地部署。(需要 Node.js 20.x,Python3,Pipenv 和 Git 环境)
git clone https://github.com/OI-tools/OI-tools.git --depth=1
cd OI-tools
# 安装依赖
pipenv install
npm install
# 两种方法(选其一即可):
# 1. 运行一个本地服务器,访问 http://127.0.0.1:8000 可以查看效果
pipenv run mkdocs serve -v
# 2. 在 site 文件夹下得到静态页面
pipenv run mkdocs build -v
# 获取 mkdocs 的命令行工具的说明(解释了命令和参数的含义)
pipenv run mkdocs --help
可以使用 gh-pages
分支的内容
git clone https://github.com/OI-tools/OI-tools.git -b gh-pages
本地启动一个 http 服务器可能会更方便一些。
# 如果是 python3
python3 -m http.server
# 如果是 python2
python2 -m SimpleHTTPServer
# 有些环境下找不到名叫 python3/python2 的可执行文件,不妨运行 python 试试
欢迎提交 PR,贡献代码或者提供建议。
要参与贡献,请先阅读 贡献指南。
除特别注明外,项目中除了代码部分均采用 GPL-3.0 许可证。