mkdocs 文档系统

mkdocs是一个基于python的静态网页构建框架，非常简单和易于管理，几乎不需要任何python和web开发基础，只需要markdown的编写就可以。

安装

pip install mkdocs

创建第一个项目

# project是你的项目名字
mkdocs new project
code project

本地打开serve

mkdocs serve

打开localhost:8000可以查看到现在的网页。

如果8000端口被占用了，我们可以在配置文件mkdocs.yml中更改端口号：

dev_addr: '127.0.0.1:5500' #默认值

这将会使网页在localhost:5500工作。

如果你在本地修改markdown的内容，会看到localhost里的内容也会更新，可以实时预览。

编译成网页

serve命令虽然方便，但我们知道光是markdown是不能在远端部署的，所以我们需要把他编译成HTML、CSS、Javascript文件，然后放到远端的服务器。

mkdocs build

这个命令会在项目下生成一个site的文件夹，里面放着编译出来的网页文件。

可以在配置文件中更改生成的网页路径：

site_dir: '../site'

这个小小的更改会使生成的site文件夹不在当前的项目目录，而是在和项目目录同一级别。

帮助

想要获得更多的帮助，可以运行：

mkdocs -h

标签：markdown,网页,serve,系统,site,文档,localhost,mkdocs
来源： https://www.cnblogs.com/ralgh/p/14526076.html