From 6f324afb3792dbb7aa0376caef664ca0845f18c3 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 14 Jan 2017 13:43:19 +0100 Subject: [PATCH 1/2] Put choco under general installation procedures --- docs/getting-started.md | 35 ++++++++++++++++++----------------- mkdocs.yml | 2 +- 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 81b9dda76..fdc7d7b37 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -41,7 +41,7 @@ pip install pymdown-extensions ### Installing Material -#### by using pip +#### using 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 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 + [8]: https://chocolatey.org/packages/python + [7]: https://chocolatey.org/packages/mkdocs + +#### cloning from GitHub Material can also be used without a system-wide installation by cloning the 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 `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 In order to enable the Material theme just add one of the following lines to diff --git a/mkdocs.yml b/mkdocs.yml index e60f188ad..33ca68bb2 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,7 +29,7 @@ repo_name: squidfunk/mkdocs-material repo_url: https://github.com/squidfunk/mkdocs-material # Copyright -copyright: 'Copyright © 2016 Martin Donath' +copyright: 'Copyright © 2016-2017 Martin Donath' # Documentation and theme theme_dir: material From c0fe88004ade2b8cc6fa320260244864cc3e75fe Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 14 Jan 2017 13:44:23 +0100 Subject: [PATCH 2/2] Fix link reference --- docs/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index fdc7d7b37..3508438cd 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -76,8 +76,8 @@ This will also install all required dependencies like [Python][7] and [5]: https://chocolatey.org [6]: https://chocolatey.org/packages/mkdocs-material - [8]: https://chocolatey.org/packages/python - [7]: https://chocolatey.org/packages/mkdocs + [7]: https://chocolatey.org/packages/python + [8]: https://chocolatey.org/packages/mkdocs #### cloning from GitHub