prenex/magcms
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[doc] document themes support

Browse Source
This commit is contained in:
Laurent Peuch 2016-02-23 06:05:13 +01:00
parent 6018624154
commit a18330bfc0
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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 A `build` folder will be created in the current directory, containing an
index.html, static files (css & js) and pictures. 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 ## TODO
* write documentation on how to overwrite the templates * write documentation on how to overwrite the templates