Warning
这个文档仓库已废弃,文档正在新仓库 ClassIsland/classisland-doc-next 上维护。
这是 ClassIsland 文档仓库。本文档基于 Material for MkDocs 搭建,目前托管在 Read The Docs 上。
-
安装 Python 3 环境
-
克隆并进入文档仓库
-
设置虚拟环境 (建议)
python -m venv ./venv ./venv/scripts/activate
-
安装依赖
python -m pip install -r requirements.txt
-
启动 MkDocs 服务器
mkdocs serve
启动 MkDocs 服务器后,在浏览器中打开终端输出的链接(默认是https://localhost:8000/)即可浏览文档。当本地文档做出更改时,浏览器中的文档将自动刷新。
本文档使用了 MkDocs 的一些扩展语法,请尽量直接编辑 Markdown 文件,而不是使用可视化 Markdown 编辑器。建议使用 Visual Studio Code 编辑文档。
关于 MkDocs 和 Material For MkDocs 的用法,请参见 MkDocs 文档 和 Material For MkDocs 文档。
如果您有意愿为本文档做出贡献,请先阅读贡献指南。我们欢迎向本仓库提交 Pull Request。
感谢以下为本文档做出贡献的同学:
本文档以 CC BY-NC-SA 4.0 许可协议授权。