From 69aa55329c9fe1e958063d0a8e5d02ef6bad5aca Mon Sep 17 00:00:00 2001 From: Laurent Peuch Date: Tue, 9 Feb 2016 23:02:56 +0100 Subject: [PATCH] [doc] try to make doc a bit clearer --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 092f238..0213795 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,9 @@ title: My exploration of the outside world sub_title: it's a scary place, don't go there ``` -If you want a menu add this in settings.yaml: +#### Menu + +It is possible to add a menu to your homepage that links to static pages. To do so, add a `menu` key to your `settings.yaml`, for example: ```yaml menu: @@ -65,7 +67,13 @@ menu: - contact: "Contact" ``` -After you need create ``about.yaml`` and ``contact.yaml`` like this: +The first part (`about` and `contact`) here are the name of the files (without +the `.yaml`) and the second part are the menu title that will be displayed in +the templates. So, here, you'll need to create a ``about.yaml`` and a +``contact.yaml`` files in the root directory. Their content are similar to +galleries (see [bellow](#gallery-settingsyaml)). + +For example, this could be the content of `contact.yaml`: ```yaml title: "Contact"