Material for MkDocs

一个 MkDocs 的 Material Design 主题。(A Material Design theme for MkDocs )

Github星跟蹤圖

Material 是 MkDocs 的主题,是针对项目文档的优秀静态站点生成器。 它是基于Google 的 Material Design 指南构建的。

快速开始

用 pip 安装最新版本的 Material:

pip install mkdocs-material

将以下行附加到项目的 mkdocs.yml中:

theme: 'material'

期待什么

  • 各种屏幕和设备的响应式设计和流体布局,旨在以用户友好的方式为您的项目文档提供最佳的可读性。
  • 易于定制的主要和重点颜色,字体,图标和标志; 通过主题延伸直接本地化; 与Google Analytics(分析),Disqus 和 GitHub 集成。
  • 精心设计的搜索界面可通过热键(F 或 S)进行访问,智能分组搜索结果,搜索词突出显示和延迟加载。

许可

MIT License

Copyright (c) 2016-2019 Martin Donath

概覽

名稱與所有者squidfunk/mkdocs-material
主編程語言HTML
編程語言HTML (語言數: 7)
平台Linux, Mac, Windows, GitHub Pages
許可證MIT License
發布數386
最新版本名稱9.5.19 (發布於 )
第一版名稱0.1.0 (發布於 )
創建於2016-01-28 22:09:23
推送於2024-04-28 16:23:26
最后一次提交2024-04-28 09:53:07
星數18.3k
關注者數127
派生數3.3k
提交數6.2k
已啟用問題?
問題數2296
打開的問題數30
拉請求數1503
打開的拉請求數3
關閉的拉請求數1353
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?

Github Action
Downloads
Gitter
PyPI
dependabot

Material for MkDocs

A Material Design theme for MkDocs.

Material for MkDocs

Quick start

Install the latest version of Material with pip:

pip install mkdocs-material

Append the following line to your project's mkdocs.yml:

theme:
  name: 'material'

What to expect

  • Responsive design and fluid layout for all kinds of screens and devices,
    designed to serve your project documentation in a user-friendly way in 40
    languages with optimal readability.

  • Easily customizable primary and accent color, fonts, favicon and logo;
    straight forward localization through theme extension; integrated with Google
    Analytics, Disqus and GitHub.

  • Well-designed search interface accessible through hotkeys (F or
    S), intelligent grouping of search results, search term
    highlighting and lazy loading.

For detailed installation instructions and a demo, visit
https://squidfunk.github.io/mkdocs-material/

Support

If you're happy with Material for MkDocs and feel like giving something back,
you may check out squidfunk's Amazon wish list.

License

MIT License

Copyright (c) 2016-2019 Martin Donath

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

去到頂部