Skip to content
Snippets Groups Projects
Commit d67bfc03 authored by squidfunk's avatar squidfunk
Browse files

Documentation fixes

parent 869687b5
No related branches found
No related tags found
No related merge requests found
...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
[![PyPI Downloads][pypi-dl-image]][pypi-dl-link] [![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
[![PyPI Version][pypi-v-image]][pypi-v-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. A material design theme for MkDocs.
...@@ -25,3 +27,7 @@ For detailed installation instructions and a demo, visit [squidfunk.github.io/mk ...@@ -25,3 +27,7 @@ For detailed installation instructions and a demo, visit [squidfunk.github.io/mk
[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material [pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png [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
\ No newline at end of file
...@@ -68,6 +68,10 @@ $primary: $red-400; ...@@ -68,6 +68,10 @@ $primary: $red-400;
$accent: $teal-a700; $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 ### Building
When you finished making your changes, you can build the theme by invoking: When you finished making your changes, you can build the theme by invoking:
...@@ -84,3 +88,5 @@ variable pointing to the aforementioned directory in your original ...@@ -84,3 +88,5 @@ variable pointing to the aforementioned directory in your original
[MkDocs]: http://www.mkdocs.org [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
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment