跳转至

mkdocs博客搭建

conda环境

conda create -n py3.10mkdocs python=3.10  
conda activate py3.10mkdocs

安装MkDocs

pip install mkdocs

如果国内网络环境不好，可以使用清华大学的镜像源。

pip install mkdocs -i https://pypi.tuna.tsinghua.edu.cn/simple

安装主题

pip install mkdocs-material

如果国内网络环境不好，可以使用清华大学的镜像源。

pip install mkdocs-material -i https://pypi.tuna.tsinghua.edu.cn/simple

新建文件名 requirements.txt ，内容如下：

jinja2~=3.0
markdown~=3.2
mkdocs~=1.5.3
mkdocs-material-extensions~=1.3
pygments~=2.16
pymdown-extensions~=10.2

# Requirements for plugins
babel~=2.10
colorama~=0.4
paginate~=0.5
regex>=2022.4
requests~=2.26

用如下命令安装需要的配置：

pip install -r requirements.txt

如果国内网络环境不好，可以使用清华大学的镜像源。

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

如用到 rss, minify, i18n 则需要安装：

pip install mkdocs-minify-plugin
pip install mkdocs-rss-plugin
pip install mkdocs-static-i18n

如果国内网络环境不好，可以使用清华大学的镜像源。

pip install mkdocs-minify-plugin -i https://pypi.tuna.tsinghua.edu.cn/simple
pip install mkdocs-rss-plugin -i https://pypi.tuna.tsinghua.edu.cn/simple
pip install mkdocs-static-i18n -i https://pypi.tuna.tsinghua.edu.cn/simple

本地调试

mkdocs serve --dev-addr=127.0.0.1:8009

如需生成静态网页，执行如下命令：

mkdocs build

隐藏文章

隐藏整个目录插件

pip install mkdocs-exclude

plugins:
  - exclude:
      glob:
        - private/*

更多用法可参考： mkdocs-exclude

部署文档

站点文件部署到以“GitHub”帐户名命名的专用存储库中的“master”分支。 因此，需要在本地系统上使用两个存储库的工作副本。 例如，请考虑以下文件结构：

note/                     <--- 源mkdocs笔记目录
    mkdocs.yml
    docs/
i-rtfsc.github.io/        <--- orgname.github.io，存放html的站点

在制作并验证项目更新后，需要将目录更改为 i-rtfsc.github.io 存储库并从那里调用 mkdocs gh-deploy 命令：

cd ../i-rtfsc.github.io

mkdocs gh-deploy --config-file ../note/mkdocs.yml --remote-branch master

评论