本地部署OI-wiki

· · 个人记录

oi-wiki.org 上有 Docker 部署，但 Docker 我没有成功。
克隆 Git 仓库后，发现目录里的 README.md介绍了如何用 MkDocs 部署，还是很简单的，照着做就行了。

（需要安装 Python3 和 Pipenv。）

如果遇到问题，可以查阅 F.A.Q. 。


#安装 pipenv
pip install pipenv

# 克隆 Git 仓库
git clone https://github.com/OI-wiki/OI-wiki.git --depth=1

cd OI-wiki

# 安装 mkdocs
pipenv install --pypi-mirror https://pypi.tuna.tsinghua.edu.cn/simple/

# 使用 OI-wiki 的自定义主题（Windows 下请使用 Git Bash 执行）
# 安装主题时将连接网络下载资源，可通过以下配置项控制下载链接
# .gitmodules:
# - url
# scripts/pre-build/install-theme-vendor.sh:
# - MATHJAX_URL
# - MATERIAL_ICONS_URL
./scripts/pre-build/install-theme.sh

# 两种方法（择需选择）：
# 1. 运行一个本地服务器，访问 http://127.0.0.1:8000 可以动态查看效果
pipenv run mkdocs serve -v

# 2. 在 site 文件夹下得到静态页面
pipenv run mkdocs build -v

# 获取 mkdocs 的命令行工具的说明（解释了命令和参数的含义）
pipenv run mkdocs --help

如果用了pipenv run mkdocs build -v，还需本地启动一个 http 服务器。

# 如果是 python3
python3 -m http.server
# 如果是 python2
python2 -m SimpleHTTPServer
# 有些环境下找不到名叫 python3/python2 的可执行文件，不妨运行 python 试试
# 末尾可加端口号