diff --git a/README.md b/README.md index d5c4226..34a0db4 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,8 @@ generic approach to "choose your page style". Global settings can be set in your root `settings.yaml`, under the `settings` key. +##### GM + Currently a `gm` settings key allows to customize the default GraphicsMagick's behavior. It looks like : ```yaml @@ -113,6 +115,22 @@ The meaning of the currently supported GraphicsMagick's settings is as follows : Any GraphicsMagick setting can be customized on a per-image basis (either `cover` or `image`, see below). +##### 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 +``` ### Gallery settings.yaml @@ -384,23 +402,6 @@ 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