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

[doc] reorganise README.md

Browse Source
This commit is contained in:
Laurent Peuch 2016-02-23 06:36:50 +01:00
parent 24a7682884
commit 1a6cdfd294
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -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. 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 : Currently a `gm` settings key allows to customize the default GraphicsMagick's behavior. It looks like :
```yaml ```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). 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 ### 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 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