From b913a607e99a61740f052be6d9e7f1da4e9a3575 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Tue, 31 Oct 2017 19:48:20 +0100 Subject: [PATCH] Updated documentation for installation --- README.md | 3 ++- docs/customization.md | 12 +++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8c46fbe21..2bd2a2b23 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,8 @@ pip install mkdocs-material Append the following line to your project's `mkdocs.yml`: ``` yaml -theme: 'material' +theme: + name: 'material' ``` ## What to expect diff --git a/docs/customization.md b/docs/customization.md index 48333da4a..48764df0b 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -71,18 +71,19 @@ main theme. ### Setup and theme structure Reference the Material theme as usual in your `mkdocs.yml`, and create a -new folder for overrides, e.g. `theme`, which you reference using `theme_dir`: +new folder for overrides, e.g. `theme`, which you reference using `custom_dir`: ``` yaml -theme: 'material' -theme_dir: 'theme' +theme: + name: 'material' + custom_dir: 'theme' ``` !!! warning "Theme extension prerequisites" - As the `theme_dir` variable is used for the theme extension process, the + As the `custom_dir` variable is used for the theme extension process, the Material theme needs to be installed via `pip` and referenced with the - `theme` parameter in your `mkdocs.yml`. + `name` parameter in your `mkdocs.yml`. The structure in the theme directory must mirror the directory structure of the original theme, as any file in the theme directory will replace the file with @@ -98,6 +99,7 @@ The directory layout of the Material theme is as follows: │ ├─ javascripts/ # JavaScript │ └─ stylesheets/ # Stylesheets ├─ partials/ +│ ├─ language/ # Localized languages │ ├─ disqus.html # Disqus integration │ ├─ footer.html # Footer bar │ ├─ header.html # Header bar