From 3ac96ee1d2e28fe3023d9451ddc78ceee2ffee30 Mon Sep 17 00:00:00 2001 From: Matt Bostock <matt@mattbostock.com> Date: Fri, 21 Apr 2017 23:54:31 +0100 Subject: [PATCH] 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`. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a442bde..2918eb98 100644 --- a/README.md +++ b/README.md @@ -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' -- GitLab