Skip to content
Snippets Groups Projects
Commit 9694d232 authored by squidfunk's avatar squidfunk Committed by Martin Donath
Browse files

Updated screens and landing page documentation

parent 43484824
Branches
No related tags found
No related merge requests found
......@@ -17,24 +17,41 @@
# Material for MkDocs
A Material Design theme for [MkDocs](http://www.mkdocs.org).
A Material Design theme for [MkDocs][1].
[![Material for MkDocs](docs/images/material.png)](http://squidfunk.github.io/mkdocs-material/)
[![Material for MkDocs](docs/images/material.png)][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/
......
docs/images/material.png

757 KiB | W: | H:

docs/images/material.png

1.28 MiB | W: | H:

docs/images/material.png
docs/images/material.png
docs/images/material.png
docs/images/material.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment