Mkdocs-material初级教程
Mkdocs-material简介
Mkdocs-material是一个基于Python的静态网站生成器，它使用Markdown语法编写文档，并使用Material Design作为默认主题。Mkdocs-material支持多种主题、插件和扩展，使得文档编写和部署变得更加简单和高效。官方文档地址：Mkdocs-material
1.安装mkdocs-material
2.在项目文件夹中创建路径架构
mkdocs new .
执行上述命令后会在项目目录生成以下文件架构
.
|-docs/
| |-index.md
|-mkdocs.yml
- docs/文件夹是存放网站所有文件的目录
- index.md网站首页文件，也可以放readme.md文件
- mkdocs.ymlmkdocs配置文件
3.编辑mkdocs.yml文件，修改mkdocs配置文件
yml
site_name: My site
site_url: https://mydomain.org/mysite
theme:
name: material
- site_name:网站名称，自定义
- site_url:网站主机名称，网站部署时必须项，本地预览可不设置
- theme:网站主题风格，具体可参考MkDocs wiki
4.运行mkdocs服务预览网站
mkdocs serve
5.创建静态网页文件
mkdocs build