简介
MkDocs 可以同时编译多个 markdown 文件,形成书籍一样的文件。有多种主题供你选择,很适合项目使用。
MkDocs 是快速,简单和华丽的静态网站生成器,可以构建项目文档。文档源文件在 Markdown 编写,使用单个 YAML 配置文件配置。
MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它具有如下几个优点:
1.1 任意托管
构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方。
1.2 大量主题
默认包含大量美观的主题。可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。
1.3 即时预览
内建的开发服务器使你在撰写文档的时候就即时预览. 它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改。
1.4 易于配置
可以配置文档主题。
1.5 交叉索引
使用MkDocs链接语法创建交叉索引。
部署
mkdir -p /opt/mkdocs
docker pull squidfunk/mkdocs-material
docker run -it --rm -v /opt/mkdocs:/docs squidfunk/mkdocs-material new cc-docs
docker run -it --name mkdocs --restart=always -v /opt/mkdocs:/docs -p 10025:8000 --workdir /docs/cc-docs squidfunk/mkdocs-material serve -a 0.0.0.0:8000
使用
浏览器
http://192.168.168.111:10025/
1.首页
2.编辑自己的网站
cd /opt/mkdocs/cc-docs
修改内容为
site_name: king
nav:
- Home: index.md
- Blog: mkdocs介绍.md
刷新页面,发现你页面内容变了
3.再次编辑自己的网站
进入目录
cd /opt/mkdocs/cc-docs/docs
编写写页面内容
vim mkdocs介绍.md
内容为:
##mk简介
MkDocs---markdown项目文档工具,是一个用来创建项目文档的快速、简单、完美的静态站点生成器,文档源码使用Markdown来撰写,用一个yml文件作为配置文档。它>具有如下几个优点:
###1.1 任意托管
构建完全的静态 HTML 站点 , 可以将它托管到 GitHub pages, Amazon S3 等任意地方。
###1.2 大量主题
默认包含大量美观的主题。可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。
###1.3 即时预览
内建的开发服务器使你在撰写文档的时候就即时预览. 它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改。
###1.4 易于配置
可以配置文档主题。
###1.5 交叉索引
使用MkDocs链接语法创建交叉索引。
再次刷新页面
发现Blog下有内容了