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

Merge pull request #99 from squidfunk/docs/format-notes-on-chocolatey

Browse Source 
Format notes on Chocolatey installation
This commit is contained in:
Martin Donath 2017-01-14 13:48:46 +01:00 committed by GitHub
commit e37f517240
2 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/getting-started.md
View File

@ -41,7 +41,7 @@ pip install pymdown-extensions
### Installing Material ### Installing Material
#### by using pip #### using pip
Material can be installed with `pip`: Material can be installed with `pip`:
@ -63,7 +63,23 @@ pip install mkdocs-material
to a self-contained solution by installing Python with Homebrew. This to a self-contained solution by installing Python with Homebrew. This
should eliminate a lot of problems you may be having with `pip`. should eliminate a lot of problems you may be having with `pip`.
#### by cloning from GitHub #### using choco
If you're on Windows you can use [Chocolatey][5] to install [Material][6]:
``` dos
choco install mkdocs-material
```
This will also install all required dependencies like [Python][7] and
[MkDocs][8].
[5]: https://chocolatey.org
[6]: https://chocolatey.org/packages/mkdocs-material
[7]: https://chocolatey.org/packages/python
[8]: https://chocolatey.org/packages/mkdocs
#### cloning from GitHub
Material can also be used without a system-wide installation by cloning the Material can also be used without a system-wide installation by cloning the
repository into a subfolder of your project's root directory: repository into a subfolder of your project's root directory:
@ -76,21 +92,6 @@ This is especially useful if you want to extend the theme and override some
parts of the theme. The theme will reside in the folder parts of the theme. The theme will reside in the folder
`mkdocs-material/material`. `mkdocs-material/material`.
### Installing using Chocolatey
If you're on Windows you can use [Chocolatey][5] to install [mkdocs-material][6]:
``` dos
choco install mkdocs-material
```
Installing [mkdocs-material][6] will take care of installing all required dependencies like [mkdocs][7] and [Python][8].
[5]: https://chocolatey.org
[6]: https://chocolatey.org/packages/mkdocs-material
[7]: https://chocolatey.org/packages/mkdocs
[8]: https://chocolatey.org/packages/Python
## Usage ## Usage
In order to enable the Material theme just add one of the following lines to In order to enable the Material theme just add one of the following lines to

2
mkdocs.yml
View File

@ -29,7 +29,7 @@ repo_name: squidfunk/mkdocs-material
repo_url: https://github.com/squidfunk/mkdocs-material repo_url: https://github.com/squidfunk/mkdocs-material
# Copyright # Copyright
copyright: 'Copyright © 2016 Martin Donath' copyright: 'Copyright © 2016-2017 Martin Donath'
# Documentation and theme # Documentation and theme
theme_dir: material theme_dir: material