From 0c4078ccda680b9f6ddac800501a77b10e79814b Mon Sep 17 00:00:00 2001 From: Adrien Beudin Date: Sun, 10 Apr 2016 17:19:38 +0200 Subject: [PATCH] update doc --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 40fe1fe..a914769 100644 --- a/README.md +++ b/README.md @@ -365,6 +365,21 @@ How to use it: image: 7.jpg ``` +#### Author + +This section is for describe the author of the story. + +```yaml + - type: author + name: Adrien Beudin + text: Some text + image: IMG_20150725_200941.jpg + twitter: beudbeud (Optional) + facebook: beudbeud (Optional) + website: plop.fr (Optional) +``` + + ### Images caption @@ -393,7 +408,25 @@ And on pictures-group - image5.jpg ``` +### Background settings +For all section you can define the background. + +Exemple for background color + +```yaml + - type: bordered-picture + background: "#555" + image: another_picture.jpg +``` + +or you can use picture + +```yaml + - type: bordered-picture + background: "url(background_picture.jpg)" + image: another_picture.jpg +``` ### Example