diff --git a/README.md b/README.md index cab56eef0..c77ecc4c8 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 \ No newline at end of file +[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 \ No newline at end of file diff --git a/docs/customization.md b/docs/customization.md index 307ef6cff..04ade664c 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -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: @@ -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 \ No newline at end of file +[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 \ No newline at end of file