1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-12 01:50:52 +01:00

Make it clearer mkdocs.yml should exist

Make it clearer that `mkdocs.yml` should exist already and the `theme` line should be added to it.

Otherwise you might follow the README as a new Mkdocs user and be confused why it complains about a missing mandatory field such as `site_name`.
This commit is contained in:
Matt Bostock 2017-04-21 23:54:31 +01:00 committed by Martin Donath
parent 8ac6712dc3
commit 3ac96ee1d2

View File

@ -26,7 +26,7 @@ Install with `pip`:
pip install mkdocs-material
```
Add the following line to your `mkdocs.yml`:
Append the following line to your existing `mkdocs.yml`:
``` yaml
theme: 'material'