thu-cs-lab / router-lab-docs

Documentation for Router Lab

Router-Lab Documentation

本项目为 Router Lab 的实验文档，采用 mkdocs 编写。

本站点的自动编译版本在 这里 发布。

撰写

本站点内容使用 Markdown 进行编写。具体可查看 mkdocs 和 mkdocs-material 文档。

如果创建了新页面，需要插入到 mkdocs.yml 的 nav 部分，否则将不会出现在编译结果中。

编译

首先安装依赖，而后编译即可：

python3 -m pip install --user -r requirements.txt # 安装 Python 依赖包
mkdocs serve # 直接在本地 serve，或者：
mkdocs build --clean # 生成于 site/ 文件夹中

生成离线版

生成 PDF 和 DOCX 版本需要（经过修改的） mkdocs-combine 插件的支持。首先安装插件：

pip3 install git+https://github.com/Harry-Chen/mkdocs-combine.git

而后运行：

make docx
make pdf

即可在 generated 目录下获得相应格式的文件。

router-lab-docs's Issues

请修复ipv6地址与markdown中emoji语法冲突的问题

在 软件实验>验收流程 一章多次出现例如fd00::a:b的地址，但是markdown会把:a:渲染为:a:，难以阅读，例：

经试验，可以把:a:全部替换为:<zero-width space>a:。