mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-12 01:50:52 +01:00
Update documentation for installation
This commit is contained in:
parent
7b585f191a
commit
1b58bba115
@ -54,4 +54,4 @@ IN THE SOFTWARE.
|
||||
[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
|
||||
|
@ -33,11 +33,7 @@ so most things can be tweaked by changing a few variables.
|
||||
### Setup
|
||||
|
||||
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:
|
||||
|
||||
``` sh
|
||||
npm install -g bower
|
||||
```
|
||||
`0.11` up and running.
|
||||
|
||||
The project itself is hosted on GitHub, so the next
|
||||
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
|
||||
cd mkdocs-material
|
||||
npm install && bower install
|
||||
npm install
|
||||
```
|
||||
|
||||
### Development
|
||||
@ -101,4 +97,4 @@ changes to the original Material theme.
|
||||
[MkDocs]: http://www.mkdocs.org
|
||||
[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
|
||||
[material-colors]: http://www.materialui.co/colors
|
||||
|
@ -339,4 +339,4 @@ markdown_extensions:
|
||||
[highlight.js]: https://highlightjs.org
|
||||
[extra]: http://www.mkdocs.org/user-guide/styling-your-docs/#customising-a-theme
|
||||
[permalinks]: https://en.wikipedia.org/wiki/Permalink
|
||||
[Admonition]: https://pythonhosted.org/Markdown/extensions/admonition.html
|
||||
[Admonition]: https://pythonhosted.org/Markdown/extensions/admonition.html
|
||||
|
@ -61,4 +61,4 @@ it up and running.
|
||||
[Google Analytics integration]: getting-started.md#google-analytics-integration
|
||||
[extendable and customizable]: customization.md
|
||||
[Gulp]: http://gulpjs.com
|
||||
[SASS]: http://sass-lang.com
|
||||
[SASS]: http://sass-lang.com
|
||||
|
Loading…
Reference in New Issue
Block a user