Skip to content

Commit

Permalink
Documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Feb 9, 2016
1 parent 869687b commit d67bfc0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Release Status][release-image]][release-link]
[![License][license-image]][license-link]

A material design theme for MkDocs.

Expand All @@ -24,4 +26,8 @@ For detailed installation instructions and a demo, visit [squidfunk.github.io/mk
[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png
[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
[release-image]: https://img.shields.io/github/release/squidfunk/mkdocs-material.svg
[release-link]: https://github.com/squidfunk/mkdocs-material/releases/latest
[license-image]: https://img.shields.io/github/license/squidfunk/mkdocs-material.svg
[license-link]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE
8 changes: 7 additions & 1 deletion docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ $primary: $red-400;
$accent: $teal-a700;
```

The color variables are defined by the SASS library [quantum-colors][] and
resemble all the colors contained in the material design palette.
[This page][material-colors] offers a really good overview of the palette.

### Building

When you finished making your changes, you can build the theme by invoking:
Expand All @@ -83,4 +87,6 @@ variable pointing to the aforementioned directory in your original
`mkdocs.yml` and you should see your documentation with your changes!

[MkDocs]: http://www.mkdocs.org
[MkDocs documentation]: http://www.mkdocs.org/user-guide/styling-your-docs/#customising-a-theme
[MkDocs documentation]: http://www.mkdocs.org/user-guide/styling-your-docs/#customising-a-theme
[quantum-colors]: https://github.com/nkpfstr/quantum-colors
[material-colors]: http://www.materialui.co/colors

0 comments on commit d67bfc0

Please sign in to comment.