diff --git a/README.md b/README.md index 22b748bccec5decaefec436bba7a51c7536594ad..8c46fbe21ca2d979c270fa1b0c9586ea745b9a7c 100644 --- a/README.md +++ b/README.md @@ -17,24 +17,41 @@ # Material for MkDocs -A Material Design theme for [MkDocs](http://www.mkdocs.org). +A Material Design theme for [MkDocs][1]. -[](http://squidfunk.github.io/mkdocs-material/) +[][2] + + [1]: http://www.mkdocs.org + [2]: http://squidfunk.github.io/mkdocs-material/ ## Quick start -Install with `pip`: +Install the latest version of Material with `pip`: ``` sh pip install mkdocs-material ``` -Append the following line to your existing `mkdocs.yml`: +Append the following line to your project's `mkdocs.yml`: ``` yaml theme: '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 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 (<kbd>F</kbd> or + <kbd>S</kbd>), intelligent grouping of search results, search term + highlighting and lazy loading. + For detailed installation instructions and a demo, visit http://squidfunk.github.io/mkdocs-material/ diff --git a/docs/images/material.png b/docs/images/material.png index 63236aa98c4833a3e10340c98122a2ce013437f0..1d20acaf2ddee93a8fd91cb9d9ef77a21017e4d4 100644 Binary files a/docs/images/material.png and b/docs/images/material.png differ diff --git a/docs/index.md b/docs/index.md index d39f87962116e6e00f02ed6cad9c3e3375e68acf..ea5ce7aa0d6d766d5aa8a472707cc60b4e7941dc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,12 +19,26 @@ Install the latest version of Material with `pip`: pip install mkdocs-material ``` -Add the following line to your `mkdocs.yml`: +Append the following line to your project's `mkdocs.yml`: ``` yaml theme: '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 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 (<kbd>F</kbd> or + <kbd>S</kbd>), intelligent grouping of search results, search term + highlighting and lazy loading. + For detailed instructions see the [getting started guide][3]. [3]: getting-started.md