安装MkDocs

准备Python virtualenv

  • 构建虚拟沙箱环境非常简单:

venv初始化
cd ~
python3 -m venv venv3
  • 激活:

激活venv
source venv3/bin/activate

安装MkDocs

  • 安装Python3模块mkdocs:

安装Python3的mkdocs模块
pip install mkdocs
pip install mkdocs-material

解决访问Google CSS和fonts

如果没有自由的互联网连接(需要能够直接访问Google服务),就会发现 MkDocs 生成的 sites 静态网页访问非常缓慢。原因可以通过浏览器的 Web inspector 检查,就可以看到 fontsCSS 都是从Google网站下载的。但是在墙内无法直接访问以下2个Google服务网址:

解决方法要么构建VPN,要么将引用上述两个Google的网址替换成国内镜像网站。后者方法稍微麻烦一些,但是不需要翻墙,所以对于景德镇居民来说还是很必要的:

  • 执行以下命令来修正python库,注意,这里我使用的是 Python virtualenv ,所以 lib 位于 ~/venv3 目录下:

替换Python库中mkdocs引用google fonts的URL
cd ~/venv3/lib
grep -R fonts.gstatic.com * | awk -F: '{print $1}' | tee ~/venv3/gfiles-1
grep -R fonts.googleapis.com * | awk -F: '{print $1}' | tee ~/venv3/gfiles-2
for file in `cat ~/venv3/gfiles-1`;do sed -i 's/fonts.gstatic.com/fonts.useso.com/g' $file;done
for file in `cat ~/venv3/gfiles-2`;do sed -i 's/fonts.googleapis.com/fonts.useso.com/g' $file;done
  • 然后重新构建网站

参考