diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 000000000..68fd4cbac Binary files /dev/null and b/.github/assets/logo.png differ diff --git a/.github/assets/screenshot.png b/.github/assets/screenshot.png new file mode 100644 index 000000000..67cdc9e2b Binary files /dev/null and b/.github/assets/screenshot.png differ diff --git a/README.md b/README.md index 0af496406..375bd45ab 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,61 @@ -[![Github Action][action-image]][action-link] -[![Downloads][downloads-image]][downloads-link] -[![Gitter][gitter-image]][gitter-link] -[![PyPI][pypi-image]][pypi-link] -[![dependabot][dependabot-image]][dependabot-link] +
+ +
- [action-image]: https://github.com/squidfunk/mkdocs-material/workflows/ci/badge.svg?branch=master - [action-link]: https://github.com/squidfunk/mkdocs-material/actions - [downloads-image]: https://img.shields.io/pypi/dm/mkdocs-material.svg - [downloads-link]: https://pypistats.org/packages/mkdocs-material - [gitter-image]: https://badges.gitter.im/squidfunk/mkdocs-material.svg - [gitter-link]: https://gitter.im/squidfunk/mkdocs-material - [pypi-image]: https://img.shields.io/pypi/v/mkdocs-material.svg - [pypi-link]: https://pypi.python.org/pypi/mkdocs-material - [dependabot-image]: https://img.shields.io/badge/dependabot-enabled-06f.svg - [dependabot-link]: https://dependabot.com ++ + + + + + + + + + + + + + + +
-# Material for MkDocs ++ Create a branded static site from a set of Markdown files to host the + documentation of your Open Source or commercial project – customizable, + searchable, mobile-friendly, 40+ languages. Set up in 5 minutes. +
-> ⚠️ __Help test [Material 5](https://github.com/squidfunk/mkdocs-material/issues/1498)!__ ++ + + +
-A Material Design theme for [MkDocs][1]. +## Features -[![Material for MkDocs](https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/docs/assets/images/material.png)][2] +* **It's just Markdown** – you just write your technical documentation in + Markdown, so there's no need to know any HTML, JavaScript or CSS. Material for + MkDocs will do the heavy lifting and generate a beautiful and functional + website. - [1]: https://www.mkdocs.org - [2]: https://squidfunk.github.io/mkdocs-material/ +* **Looks great on every device**: Material for MkDocs is built... ## Quick start -Install the latest version of Material with `pip`: +Install the latest version of Material for MkDocs with `pip`: ``` sh pip install mkdocs-material @@ -41,29 +68,10 @@ 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 41 - 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/ +[squidfunk.github.io/mkdocs-material][1] -## Support - -If you're happy with Material for MkDocs and feel like giving something back, -you may check out squidfunk's [Amazon wish list][3]. - - [3]: https://amzn.to/353WRpj + [1]: https://squidfunk.github.io/mkdocs-material/ ## License diff --git a/src/overrides/home.html b/src/overrides/home.html index ada5edfb3..4e1c04700 100644 --- a/src/overrides/home.html +++ b/src/overrides/home.html @@ -26,6 +26,7 @@ {% block tabs %} {{ super() }} +