跳转至

Mkdocs

导言

mkdocs在今年支持了blog的基本功能,而且已经有探路者实践过了1。也是时候升级博客生成器了。

Why I choose Mkdocs

  1. Active code community
  2. More and more attractive featrues: Built-in search, code annotations, comment box, multi-language support
  3. detailed design: last changed time, time2Reading
  4. build with python

Getting Started

Follwing the ref

# install
pip install mkdocs-material
# Creating your site
mkdocs new .
# configuration mkdocs.yml with your favota

# test
mkdocs serve 
# build static pages to site directory in default
mkdocs build

features config

vim mkdocs.yml ref

Mkdocs support blog with blog plugin

  1. Archive (auto)
  2. category (auto)
  3. tags(auto)

项目结构

如何使用

已经有项目代码

lug

  1. (建议)使用 python3 -m venv venv 创建虚拟环境,. venv/bin/activate 进入虚拟环境;
  2. 使用 pip install -r requirements.txt 安装依赖;
  3. 使用 mkdocs serve 构建并查看效果。
  4. ``
  5. ssh -vL 8000:127.0.0.1:8000 -N -f -l shaojiemike snode6.acsalab.com to forward to localhost

各种插件

显示last update

pip3 install mkdocs-git-revision-date-localized-plugin

折叠blog

迁移工作

在熟悉了mkdocs的使用后,参考jie哥的迁移blog

需要进一步的研究学习

有待理解 jie哥

遇到的问题

暂无

开题缘由、总结、反思、吐槽~~

参考文献

上面回答部分来自ChatGPT-3.5,没有进行正确性的交叉校验。