快速生成静态页面——MkDocs

概述：基于MkDocs快速构建静态页面

文档由Markdown编写，自动生成网页形式，主要用于构建项目文档，通过一个 YAML 文件进行配置。

1.安装MkDocs

pip install mkdocs

2.构建项目

mkdocs new myProject
cd my-project

3.启动服务器

mkdocs serve

mkdocs serve 0.0.0.0:8000 // 外网访问

4.查看页面

http://127.0.0.1:8000

5.修改网页标题

修改mkdocs.yml

site_name: 新标题

6.添加页面

在docs/中新增md文件

在site_name.yml中可设置导航栏及左侧

site_name: MkLorum
nav:
    - Home: index.md
    - About: about.md

7.修改主题

site_name: MkLorum
nav:
    - Home: index.md
    - About: about.md
theme: readthedocs

8.更正图标

（1）创建子目录img

（2）将自定义favicon.ico复制到该目录即可

9.建立网站

mkdocs build

项目所在目录生成site新目录，包含index.html、sitemap.xml等

10.查看帮助

mkdocs build --help # 查看帮助
lsof -i:8000 # 

11.帮助文档

github:https://github.com/mkdocs/mkdocs

documentation:https://www.mkdocs.org/

12.后台启动服务

关闭SSH仍保持当前运行的进程

nohup mkdocs serve -a 0.0.0.0:8000 &

查看后台日志：

tailf nohup.out