Mkdocs
Why I choose Mkdocs
- Active code community
- More and more attractive featrues: Built-in search, code annotations, comment box, multi-language support
- detailed design: last changed time, time2Reading
- build with python
Getting Started
Follwing the ref
1 | # install |
features config
vim mkdocs.yml
ref
Mkdocs support blog with blog plugin
- Archive (auto)
- category (auto)
- tags(auto)
项目结构
如何使用
已经有项目代码
如lug
- (建议)使用
python3 -m venv venv
创建虚拟环境,. venv/bin/activate
进入虚拟环境; - 使用
pip install -r requirements.txt
安装依赖; - 使用
mkdocs serve
构建并查看效果。- ``
ssh -vL 8000:127.0.0.1:8000 -N -f -l shaojiemike snode6.acsalab.com
to forward to localhost
各种插件
显示last update
1 | pip3 install mkdocs-git-revision-date-localized-plugin |
折叠blog
迁移工作
在熟悉了mkdocs的使用后,参考jie哥的迁移blog
需要进一步的研究学习
有待理解 jie哥
遇到的问题
暂无
开题缘由、总结、反思、吐槽~~
参考文献
上面回答部分来自ChatGPT-3.5,没有进行正确性的交叉校验。
无