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

Added hint to documentation on GNU Make (#1120)

Browse Source 
If you're trying to build mkdocs-material on Windows, it seems GNU make is required. It's not hard to install it, but it's worth linking in the docs.
This commit is contained in:
Hampton 2019-06-03 01:27:57 -05:00 committed by Martin Donath
parent b2125dae24
commit c483ff0db8
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/customization.md
View File

@ -192,8 +192,10 @@ cd mkdocs-material
pip install -r requirements.txt pip install -r requirements.txt
npm install npm install
``` ```
If you're on Windows, you may also need to install [GNU Make][9]
[8]: https://nodejs.org [8]: https://nodejs.org
[9]: http://gnuwin32.sourceforge.net/packages/make.htm
### Development mode ### Development mode
@ -205,7 +207,7 @@ npm run watch
This will also start the MkDocs development server which will monitor changes This will also start the MkDocs development server which will monitor changes
on assets, templates and documentation. Point your browser to on assets, templates and documentation. Point your browser to
[localhost:8000][9] and you should see this documentation in front of you. [localhost:8000][10] and you should see this documentation in front of you.
For example, changing the color palette is as simple as changing the For example, changing the color palette is as simple as changing the
`$md-color-primary` and `$md-color-accent` variables in `$md-color-primary` and `$md-color-accent` variables in
@ -222,7 +224,7 @@ $md-color-accent: $clr-teal-a700;
directory are automatically generated from the `src` directory and will be directory are automatically generated from the `src` directory and will be
overridden when the theme is built. overridden when the theme is built.
[9]: http://localhost:8000 [10]: http://localhost:8000
### Build process ### Build process