From a18330bfc0b8f9223409f9e5f2ec086beece0863 Mon Sep 17 00:00:00 2001 From: Laurent Peuch Date: Tue, 23 Feb 2016 06:05:13 +0100 Subject: [PATCH] [doc] document themes support --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 96977bd..8511143 100644 --- a/README.md +++ b/README.md @@ -384,6 +384,23 @@ In a folder containing the **root** settings.yaml file, simply do A `build` folder will be created in the current directory, containing an index.html, static files (css & js) and pictures. +## Themes + +Prosopopée has a support for various themes. As for now, only 2 themes are available: + +* the default one called "exposure" +* "material" based on materialcss + +To specify the theme, add the "theme" key in your "settings" key or your +**root** settings.yaml. For example: + +```yaml +title: My exploration of the outside world +sub_title: it's a scary place, don't go there +settings: + theme: material +``` + ## TODO * write documentation on how to overwrite the templates