OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for installation

Browse Source
This commit is contained in:
Brendan Abbott 2016-10-12 17:13:57 +10:00
parent 7b585f191a
commit 1b58bba115
4 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -54,4 +54,4 @@ IN THE SOFTWARE.
[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png [pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png
[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

10
docs/customization.md
View File

@ -33,11 +33,7 @@ so most things can be tweaked by changing a few variables.
### Setup ### Setup
In order to compile the project, you need `node` with a version greater than In order to compile the project, you need `node` with a version greater than
`0.11` up and running. Then, make sure `bower` is installed or install it: `0.11` up and running.
``` sh
npm install -g bower
```
The project itself is hosted on GitHub, so the next The project itself is hosted on GitHub, so the next
thing you should do is clone the project from GitHub: thing you should do is clone the project from GitHub:
@ -51,7 +47,7 @@ Then you change the directory and install all dependencies specified in the
``` sh ``` sh
cd mkdocs-material cd mkdocs-material
npm install && bower install npm install
``` ```
### Development ### Development
@ -101,4 +97,4 @@ changes to the original Material theme.
[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 [quantum-colors]: https://github.com/nkpfstr/quantum-colors
[material-colors]: http://www.materialui.co/colors [material-colors]: http://www.materialui.co/colors

2
docs/getting-started.md
View File

@ -339,4 +339,4 @@ markdown_extensions:
[highlight.js]: https://highlightjs.org [highlight.js]: https://highlightjs.org
[extra]: http://www.mkdocs.org/user-guide/styling-your-docs/#customising-a-theme [extra]: http://www.mkdocs.org/user-guide/styling-your-docs/#customising-a-theme
[permalinks]: https://en.wikipedia.org/wiki/Permalink [permalinks]: https://en.wikipedia.org/wiki/Permalink
[Admonition]: https://pythonhosted.org/Markdown/extensions/admonition.html [Admonition]: https://pythonhosted.org/Markdown/extensions/admonition.html

2
docs/index.md
View File

@ -61,4 +61,4 @@ it up and running.
[Google Analytics integration]: getting-started.md#google-analytics-integration [Google Analytics integration]: getting-started.md#google-analytics-integration
[extendable and customizable]: customization.md [extendable and customizable]: customization.md
[Gulp]: http://gulpjs.com [Gulp]: http://gulpjs.com
[SASS]: http://sass-lang.com [SASS]: http://sass-lang.com