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

Updated documentation for installation

Browse Source
This commit is contained in:
squidfunk 2017-10-31 19:48:20 +01:00 committed by Martin Donath
parent f68d7beb94
commit b913a607e9
2 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -35,7 +35,8 @@ pip install mkdocs-material
Append the following line to your project's `mkdocs.yml`: Append the following line to your project's `mkdocs.yml`:
``` yaml ``` yaml
theme: 'material' theme:
name: 'material'
``` ```
## What to expect ## What to expect

12
docs/customization.md
View File

@ -71,18 +71,19 @@ main theme.
### Setup and theme structure ### Setup and theme structure
Reference the Material theme as usual in your `mkdocs.yml`, and create a 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 ``` yaml
theme: 'material' theme:
theme_dir: 'theme' name: 'material'
custom_dir: 'theme'
``` ```
!!! warning "Theme extension prerequisites" !!! 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 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 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 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 │ ├─ javascripts/ # JavaScript
│ └─ stylesheets/ # Stylesheets │ └─ stylesheets/ # Stylesheets
├─ partials/ ├─ partials/
│ ├─ language/ # Localized languages
│ ├─ disqus.html # Disqus integration │ ├─ disqus.html # Disqus integration
│ ├─ footer.html # Footer bar │ ├─ footer.html # Footer bar
│ ├─ header.html # Header bar │ ├─ header.html # Header bar