Skip to content

Commit d67bfc0

Browse files
committed
Documentation fixes
1 parent 869687b commit d67bfc0

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
44
[![PyPI Version][pypi-v-image]][pypi-v-link]
5+
[![Release Status][release-image]][release-link]
6+
[![License][license-image]][license-link]
57

68
A material design theme for MkDocs.
79

@@ -24,4 +26,8 @@ For detailed installation instructions and a demo, visit [squidfunk.github.io/mk
2426
[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png
2527
[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material
2628
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
27-
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
29+
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
30+
[release-image]: https://img.shields.io/github/release/squidfunk/mkdocs-material.svg
31+
[release-link]: https://github.com/squidfunk/mkdocs-material/releases/latest
32+
[license-image]: https://img.shields.io/github/license/squidfunk/mkdocs-material.svg
33+
[license-link]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE

docs/customization.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ $primary: $red-400;
6868
$accent: $teal-a700;
6969
```
7070

71+
The color variables are defined by the SASS library [quantum-colors][] and
72+
resemble all the colors contained in the material design palette.
73+
[This page][material-colors] offers a really good overview of the palette.
74+
7175
### Building
7276

7377
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
8387
`mkdocs.yml` and you should see your documentation with your changes!
8488

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

0 commit comments

Comments
 (0)