当前位置：首页 > 软件库 > Web应用开发 > 网页开发工具 >

MkDocs Material

为 MkDocs 带来 Material Design 主题

授权协议 MIT

开发语言 TypeScript

所属分类 Web应用开发、网页开发工具

软件类型开源软件

地区不详

投递者顾昌翰

操作系统跨平台

开源组织无

适用人群未知

软件概览

MkDocs 是快速，简单和华丽的静态网站生成器，可以构建项目文档。文档源文件在 Markdown 编写，使用单个 YAML 配置文件配置。MkDocs 构建的 HTML 网站，可以被托管在 GitHub、Amazon S3 或其他任何位置。

虽然 MkDocs 已经提供了许多漂亮的主题。但 MkDocs Material 将 Android 系统中采用的 Material Design 设计带到了 MkDocs 上。

特征

只是 Markdown ——用普通的 Markdown 写技术文档，无需了解 HTML、JavaScript 或 CSS。MkDocs Material 将会为你进行剩余的繁重工作，并将 Markdown 转换为美观而实用的网站。
响应式设计——底层的 fluid 布局将始终完美地适应屏幕空间。
静态但可搜索 ——技术文档网站可以搜索内容。MkDocs Material 内置搜索，无需服务器就可以立即相应用户的查询。
丰富的配置选项 —— 更改调色板、字体、语言、图示和徽标。添加源仓库链接，可以链接用户个人的社交媒体、Google Analytics 和 Disqus。
真正的国际化 —— MkDocs Material 支持 40多种语言，并为特定语言提供完整的从右到左阅读的支持。
现代体系结构— MkDocs Material 基础代码库使用的是 TypeScript、RxJS 和 SCSS 构建，并使用 Webpack 进行编译，这为主题扩展和自定义提供了更多的可能性。

可以通过pip安装 MkDocs Material

pip install mkdocs-material

将以下命令添加进 mkdocs.yml:

theme:
  name: material

使用案例

使用mkdocs搭建文档系统（使用material主题美化）

基础入门使用material主题美化插件和功能添加（待更新）使用docker管理（待更新） material是一个mkdocs主题，它的优点：谷歌的material设计风格。渐进式布局，可以适配各种设备访问。支持非常多的插件和扩展，个人试过不少mkdocs主题，material的可扩展性是最好的。安装 pip install mkdocs-material 在配置文件中添加: th
使用 mkdocs material 编写文档

更换镜像源一、Windows更改pip镜像源 (1)在windows文件管理器中,输入 %APPDATA% (2)会定位到一个新的目录下，在该目录下新建pip文件夹，然后到pip文件夹里面去新建个pip.ini文件 (3)在新建的pip.ini文件中输入以下内容，搞定文件路径： “C:\Users\Administrator\AppData\Roaming\pip\pip.ini” [globa
docker 部署 mkdocs (mkdocs-material)

环境：ubuntu16.04 LTS mkdocs官网有详细的安装步骤。下面的方法是通过docker来部署。获取镜像 $ docker search mkdocs NAME DESCRIPTION STARS OFFI
通过 Github Actions 部署 Mkdocs 文档

Mkdocs 是一个采用 Python 构建轻量级的静态 HTML 在线文档框架，内置部署到 Github Pages 的功能。我用来创建实践指南，用来做个人的知识积累。安装 Mkdocs 以及 Mkdocs 主题 Mkdocs 以及主题都通过pip安装，例如我采用的mkdocs-material主题，如下所示： pip install --user mkdocs mkdocs-material