KU-WIKI

KU-WIKI

本WIKI基于mkdocs.org. 本WIKI基于mkdocs.org.

欢迎大家一起来施工喵。

NOTE：这是README，主页显示的是docs/index.html

如何编辑

请在main分支下进行编辑。

总之先在docs里写文档，mkdocs.yml里写目录吧。 图片请在各自的目录下创建assets/images。

安装 mkdocs 以进行测试：

pip install mkdocs

使用如下指令在本地搭建服务器以测试：

python -m mkdocs serve

使用如下指令编译（？）项目：

python -m mkdocs build

使用如下指令推送项目到gh-pages分支（部署用分支）：

python -m mkdocs build

别忘了再推送到此main分支（开发分支）。

使用如下指令打印帮助：

mkdocs -h

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

使用Docker构建本地环境

进入到工程目录下，运行下面的命令构建容器

docker compose up

进入到容器内Terminal

docker compose exec mkdocs bash

执行构建命令

python -m mkdocs build

python -m mkdocs serve -a 0.0.0.0:8000/