MkDocs Material为 MkDocs 带来 Material Design 主题

联合创作 · 2023-09-19 19:51

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
浏览 5
点赞
评论
收藏
分享

手机扫一扫分享

编辑 分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

编辑 分享
举报