安装¶
MkDocs材料提供了广泛的选项,用于定制您的 文档。在本节中,我们将解释如何创建一个有意义的 为您的网站构建结构,改变外观和感觉,添加博客和评论系统, 并构建一个高度优化的网站。
站点结构¶
通过配置来设置和自定义文档的结构 根据您的喜好选择页眉和页脚,在多种导航模式中进行选择, 设置网站搜索等。
- :fontawesome-solid-earth-americas: Language – 从支持的60多种语言中选择或添加一种新语言
- :material-page-layout-sidebar-left: Navigation – 创建清晰、简洁、全面的导航结构
- :material-page-layout-header: Header – 自定义标题的行为,添加公告栏
- :material-page-layout-footer: Footer – 在页脚中添加指向您的社交媒体个人资料或网站的链接
- :material-tab-search: Search – 设置和配置搜索,完全在用户的浏览器中运行
- :material-tag-plus-outline: Tags – 使用标签和组相关页面对页面进行分类
外貌¶
用几行文字匹配你的品牌的颜色、字体、图标、徽标等 配置–MkDocs的材料使扩展基本功能变得容易 配置或更改外观。
- :material-brush-variant: Colors – 使用现有调色板更改颜色或使用CSS进行自定义
- :material-format-font: Fonts – 从1000种谷歌字体中选择或加载自托管字体
- :material-google-downasaur: Logo & Icons – 更改徽标,使用8000多个图标中的任何一个,或添加新图标
- :material-cards-variant: Social Cards – 共享链接时自动创建社交媒体预览
所容纳之物¶
创建博客,集成评论系统,连接git存储库,并设置 与项目版本控制方法相匹配的版本化文档。
- :material-book-open-outline: Blog – 设置一个独立的博客或将其与文档放在一起
- :material-comment-text-outline: Comment System – 在任何页面或页脚上添加第三方评论系统
- :octicons-versions-16: Versioning – 通过与外部实用程序集成部署多个版本
- :octicons-repo-16: Repository – 将文档连接到git存储库
优化¶
添加网站分析,并通过添加自动图像构建优化的网站 压缩,遵守GDPR数据隐私法规,并使其 离线功能。
- :material-google-analytics: Site analytics – 了解您的用户如何体验您的文档
- :material-screwdriver: Optimized site – 创建在搜索引擎上排名靠前的优化网站
- :octicons-lock-16: Data Privacy – 确保遵守数据隐私法规
- :octicons-cloud-offline-16: Offline usage – 构建具有在线和离线功能的文档