[mod] retab

This commit is contained in:
Laurent Peuch 2016-05-04 09:30:08 +02:00
parent 2f35eaf66b
commit 7e17414966

View File

@ -24,19 +24,19 @@ ____
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:: 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::
menu: menu:
- about: "About" - about: "About"
- first_gallery: "My first gallery" - first_gallery: "My first gallery"
- http://twitter.com: "Twitter" - http://twitter.com: "Twitter"
For example, this could be the content of `settings.yaml` in `about` folder:: For example, this could be the content of `settings.yaml` in `about` folder::
title: "About" title: "About"
static: true static: true
public: false public: false
sections: sections:
- type: text - type: text
text: Some text, HTML <b>is allowed</b>. text: Some text, HTML <b>is allowed</b>.
You can use the `static` option to get a template closer to the one of the You can use the `static` option to get a template closer to the one of the
homepage that is better suited for a static page. You'll need to specify homepage that is better suited for a static page. You'll need to specify
@ -57,12 +57,12 @@ 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 ::
settings: settings:
gm: gm:
quality: 75 quality: 75
auto-orient: True auto-orient: True
strip: True strip: True
resize: 50% resize: 50%
The meaning of the currently supported GraphicsMagick's settings is as follows : The meaning of the currently supported GraphicsMagick's settings is as follows :
@ -78,14 +78,14 @@ Video convertor
Prosopopée can use ffmpeg or libav and if you want you can customize the settings:: Prosopopée can use ffmpeg or libav and if you want you can customize the settings::
settings: settings:
ffmpeg: ffmpeg:
binary: "ffmpeg" binary: "ffmpeg"
loglevel: "panic" loglevel: "panic"
format: "webm" format: "webm"
resolution: "1280x720" resolution: "1280x720"
bitrate: "3900k" bitrate: "3900k"
preselect: "libvpx-720p" preselect: "libvpx-720p"
Themes Themes
~~~~~~ ~~~~~~
@ -98,10 +98,10 @@ Prosopopée has a support for various themes. As for now, only 2 themes are avai
To specify the theme, add the "theme" key in your "settings" key or your To specify the theme, add the "theme" key in your "settings" key or your
**root** settings.yaml. For example:: **root** settings.yaml. For example::
title: My exploration of the outside world title: My exploration of the outside world
sub_title: it's a scary place, don't go there sub_title: it's a scary place, don't go there
settings: settings:
theme: material theme: material
Licence Licence
~~~~~~~ ~~~~~~~
@ -109,9 +109,9 @@ Licence
By default Prosopopée use CC-BY-SA for all the content, if you want use a another licence By default Prosopopée use CC-BY-SA for all the content, if you want use a another licence
you need add key in **root** settings.yaml. For example:: you need add key in **root** settings.yaml. For example::
licence: licence:
name: WTFPL name: WTFPL
url: "http://www.wtfpl.net/txt/copying/" url: "http://www.wtfpl.net/txt/copying/"
Share Share
~~~~~ ~~~~~
@ -119,16 +119,16 @@ Share
If you want enable the share content on social network, add key in **root** settings.yaml. For example: If you want enable the share content on social network, add key in **root** settings.yaml. For example:
By defaut you can share on facebook, twitter, pinterest, google+:: By defaut you can share on facebook, twitter, pinterest, google+::
share: true share: true
url: "http://prosopopee.com" url: "http://prosopopee.com"
RSS RSS
~~~ ~~~
For activate the RSS you need add this key in **root** settings.yaml:: For activate the RSS you need add this key in **root** settings.yaml::
rss: true rss: true
url: "http://prosopopee.com" url: "http://prosopopee.com"
Gallery settings.yaml Gallery settings.yaml
@ -147,43 +147,43 @@ _______
:: ::
title: Gallery title title: Gallery title
sub_title: Gallery sub-title sub_title: Gallery sub-title
date: 2016-01-15 date: 2016-01-15
cover: my_cover_picture.jpg cover: my_cover_picture.jpg
tags: tags:
- #yolo - #yolo
- #travel - #travel
sections: sections:
- type: full-picture - type: full-picture
image: big_picture.jpg image: big_picture.jpg
text: text:
title: Big picture title title: Big picture title
sub_title: Some text sub_title: Some text
date: 2016-01-15 date: 2016-01-15
- type: pictures-group - type: pictures-group
images: images:
- -
- image1.jpg - image1.jpg
- image2.jpg - image2.jpg
- image3.jpg - image3.jpg
- -
- image4.jpg - image4.jpg
- image5.jpg - image5.jpg
- type: text - type: text
text: Some text, HTML <b>is allowed</b>. text: Some text, HTML <b>is allowed</b>.
- type: bordered-picture - type: bordered-picture
image: another_picture.jpg image: another_picture.jpg
And here is an example or a **private** gallery (notice the ``public`` keyword):: And here is an example or a **private** gallery (notice the ``public`` keyword)::
title: Gallery title title: Gallery title
sub_title: Gallery sub-title sub_title: Gallery sub-title
date: 2016-01-15 date: 2016-01-15
cover: my_cover_picture.jpg cover: my_cover_picture.jpg
public: false public: false
sections: sections:
- ... - ...
Advanced settings Advanced settings
----------------- -----------------
@ -204,8 +204,8 @@ For example, you can replace::
by:: by::
image: image:
name: image1.jpg name: image1.jpg
quality: 90 quality: 90
strip: False strip: False
auto-orient: False auto-orient: False