↓Skip to main content
  1. Posts/

MkDocs的安装和使用

·717 words
BLOG mkdocs
Table of Contents

前言
#

鉴于我想要精进一下自己的技术，但是没有什么方向，所以我找到了mkdocs这个静态网站生成器来学习。我觉得mkdocs比起hugo更适合用来做教程网站和相关的固定内容网站展示。

安装
#

pip安装
#

一开始我用arch的时候，无法用pip安装上mkdocs，但是后面我换成rocky 9，就可以了。我没想继续arch的报错，而不是换一个环境安装，我觉得是正常的做法。毕竟只是用来练手的。知道原理就好。

前置条件
#

  • rocky 9
  • python
  • pip

安装命令
#

pip install mkdocs

docker安装
#

不得不说现在1panel确实给Linux的使用带来了便利，如果直接部署mkdocs报错的概率还是挺大的，但是1panel的docker模式就可以做到安装成功率高。而使用也是很方便的，只需要更改特定的文件即可。当然，熟悉的朋友也可以直接用docker安装。

前置条件
#

  • centos 7
  • 1panel

安装方式
#

在1panel的应用商店找到mkdocs并安装（记得开发端口）。

使用
#

mkdocs的使用，困难处不在于修改文件，而在于了解其目录框架。mkdocs不同于hugo，其目录可能需要自己编写（尚未验证，按照我对参考网址配置文件的理解），hugo则是可以直接放在外部，编写主题的配置文件即可。

pip
# 

cd blog  
mkdocs new blog
mkdocs serve  
pip install mkdocs-material

cd到目录，生成目录blog，测试，下载主题

yml和yaml文件是配置文件，修改即可

1panel
#

应用商店下载安装。 在“已安装”里进入mkdocs目录，放入md文件和修改配置文件。

总结
#

对比下来，1panel更加简单一些。不过熟悉的人，我觉得可能更适应用pip安装的方式来管理。我目前对mkdocs的了解就这么多，不过之后我可能会用更多的实践来完善，之后的计划是学会修改mkdocs的配置文件。

参考网址
#

收款码