diff --git a/docs/assets/images/illustration.png b/docs/assets/images/illustration.png new file mode 100644 index 000000000..95e7390dc Binary files /dev/null and b/docs/assets/images/illustration.png differ diff --git a/docs/assets/images/material.png b/docs/assets/images/material.png deleted file mode 100644 index 25feb091f..000000000 Binary files a/docs/assets/images/material.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index a363caef9..ad49ab437 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,49 +1,4 @@ --- template: overrides/home.html +title: Material for MkDocs --- - -# Material for MkDocs - -## Create beautiful project documentation - -Material is a theme for [MkDocs][1], an excellent static site generator geared -towards project documentation. It is built using Google's [Material Design][2] -guidelines. - -[![Material for MkDocs](assets/images/material.png)](assets/images/material.png) - - [1]: https://www.mkdocs.org - [2]: https://material.io/design/ - -## Quick start - -Install the latest version of Material with `pip`: - -``` sh -pip install mkdocs-material -``` - -Add the following line to `mkdocs.yml`: - -``` yaml -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 instructions see the [getting started guide][3]. - - [3]: getting-started.md diff --git a/material/overrides/home.html b/material/overrides/home.html index 9a7929d9f..b7e4771eb 100644 --- a/material/overrides/home.html +++ b/material/overrides/home.html @@ -1,7 +1,33 @@ {#- This file was automatically generated - do not edit -#} -{% extends "base.html" %} -{% block announce %} - Material for MkDocs 5.0.0rc3 +{% extends "overrides/main.html" %} +{% block tabs %} + {{ super() }} + +
+
+
+
+ +
+
+

Beautiful and functional project documentation

+

+ Create a static site to host the documentation of your Open Source + or commercial project in a matter of minutes – hackable, + mobile-ready, translated into 41 languages, client-side search. +

+ + Get started + + + Go to GitHub + +
+
+
+
{% endblock %} +{% block content %}{% endblock %} +{% block footer %}{% endblock %} diff --git a/material/overrides/main.html b/material/overrides/main.html new file mode 100644 index 000000000..9a7929d9f --- /dev/null +++ b/material/overrides/main.html @@ -0,0 +1,7 @@ +{#- + This file was automatically generated - do not edit +-#} +{% extends "base.html" %} +{% block announce %} + Material for MkDocs 5.0.0rc3 +{% endblock %} diff --git a/src/overrides/home.html b/src/overrides/home.html index b66832568..9f04af97a 100644 --- a/src/overrides/home.html +++ b/src/overrides/home.html @@ -20,8 +20,167 @@ IN THE SOFTWARE. --> -{% extends "base.html" %} +{% extends "overrides/main.html" %} -{% block announce %} - Material for MkDocs 5.0.0rc3 + +{% block tabs %} + {{ super() }} + + + + +
+
+
+ + +
+ +
+ + +
+

Beautiful and functional project documentation

+

+ Create a static site to host the documentation of your Open Source + or commercial project in a matter of minutes – hackable, + mobile-ready, translated into 41 languages, client-side search. +

+ + Get started + + + Go to GitHub + +
+
+
+
{% endblock %} + + +{% block content %}{% endblock %} + + +{% block footer %}{% endblock %}