Material for MkDocs 是 MkDocs的一个主题配置,同时也是一个功能齐全的静态网站生成工具,能够解决上面提到的GitHub Pages的问题。

Material for MkDocs 使用广泛,下面是一些大公司和知名开源项目的使用例子:

  • AWS Copilot CLI
  • Google Accompanist
  • MicroSoft Code With Engineering Playbook
  • Mozilla Foundation Engineering Handbook
  • Netflix Titus
  • CentOS Infra docs
  • electron-builder
  • Kubernetes

用Markdown编写文档,并在几分钟内为您的开源或商业项目创建一个专业的静态网站——可搜索、可定制,适用于所有设备的60多种语言。

mkdocs:

  • python编写的markdown解释器、编译器,带有本地cli工具
  • 自带基于Tornado的小型http服务,用于本地调试
  • 内置一键式发布至GitHub Pages
  • 内置mkdocs风格、readthedocs风格的主题,并支持自定义主题
  • 支持调用python模块实现语法及渲染的扩展

mkdocs-material:

  • python模块,符合google material ui规范的mkdocs自定义主题
  • 针对特定语法、功能做了渲染优化
  • 根据客户端浏览器页面尺寸自动缩放,对PC、移动设备都友好
  • 丰富的页面配色,多达19种主体配色和16种悬停链接文字配色
  • 支持中文搜索
  • 支持统计功能,如百度统计,谷歌统计

GitHub地址:https://github.com/squidfunk/mkdocs-material

历史上的今天
02月
14
    抱歉,历史上的今天作者很懒,什么都没写!
声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。