主要特点
Markdown支持:MkDocs支持标准的Markdown语法,使得编写文档变得简单快捷。
主题丰富:MkDocs提供了多种预设主题,用户可以选择一个主题来定制文档的外观和感觉。其中,Material for MkDocs是基于MkDocs的强大文档框架,提供了现代化的设计风格和丰富的功能。
导航栏:MkDocs可以自动生成一个导航栏,方便用户在不同页面间导航。
版本控制:MkDocs支持文档的版本控制,可以为不同版本的项目维护不同的文档集。
插件系统:MkDocs拥有一个插件系统,允许用户扩展其功能,例如添加自定义的导航栏、搜索功能等。
国际化:MkDocs支持多语言文档,可以为不同语言的用户提供本地化的文档。
部署简单:生成的文档是静态HTML文件,可以部署在任何静态文件服务器上,包括GitHub Pages、GitLab Pages等。
实时预览:MkDocs提供了一个开发服务器,可以在编写文档时提供实时预览,方便查看文档效果。
使用说明
创建项目:使用MkDocs命令可以创建一个新的项目,该命令会在当前目录下创建一个包含docs目录和mkdocs.yml配置文件的目录结构。
编写文档:在docs目录中编写Markdown格式的文档文件,这些文件将作为网站的源文件。
预览网站:使用MkDocs的开发服务器命令可以在本地预览网站效果,同时支持实时预览功能,方便用户随时查看文档效果。
生成静态网站:使用MkDocs的构建命令可以将Markdown文件编译成静态HTML文件,生成的文件将保存在指定的目录中。
部署网站:将生成的静态HTML文件部署到任意静态文件服务器上即可发布网站。
如需了解更多信息,可以访问其官方网站或查阅相关的技术文档。
官方网站 https://squidfunk.github.io/mkdocs-material/
Docker镜像 https://hub.docker.com/r/squidfunk/mkdocs-material
GitHub地址 https://github.com/squidfunk/mkdocs-material
安装教程
Docker部署操作步骤:安装Docker、拉取镜像、启动容器。
| 安装docker
sudo apt update
sudo apt install -y docker.io docker-compose
| 拉取镜像
sudo docker pull squidfunk/mkdocs-material
| 启动容器
sudo docker run -itd --name mkdocs --restart=always -v /mnt/hgfs/SharedSpaces/mkdocs:/docs -p 58000:8000 --workdir /docs/cc-docs squidfunk/mkdocs-material serve -a 0.0.0.0:8000
在浏览器访问ip:58000即可。
更多内容也可看笔者出版图书!