Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2025-01-30 19:33:53 +01:00
Code Issues Releases Wiki Activity

Updated screens and landing page documentation

Browse Source
This commit is contained in:
squidfunk 2017-09-06 10:18:57 +02:00 committed by Martin Donath
parent 43484824ee
commit 9694d23223
3 changed files with 36 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -17,24 +17,41 @@
# Material for MkDocs # 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 ## Quick start
Install with `pip`: Install the latest version of Material with `pip`:
``` sh ``` sh
pip install mkdocs-material pip install mkdocs-material
``` ```
Append the following line to your existing `mkdocs.yml`: Append the following line to your project's `mkdocs.yml`:
``` yaml ``` yaml
theme: 'material' 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 For detailed installation instructions and a demo, visit
http://squidfunk.github.io/mkdocs-material/ http://squidfunk.github.io/mkdocs-material/

BIN
docs/images/material.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 757 KiB

After

Width:  |  Height:  |  Size: 1.3 MiB

16
docs/index.md
View File

@ -19,12 +19,26 @@ Install the latest version of Material with `pip`:
pip install mkdocs-material pip install mkdocs-material
``` ```
Add the following line to your `mkdocs.yml`: Append the following line to your project's `mkdocs.yml`:
``` yaml ``` yaml
theme: 'material' 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]. For detailed instructions see the [getting started guide][3].
[3]: getting-started.md [3]: getting-started.md