update doc
This commit is contained in:
parent
7b193c5be1
commit
0c4078ccda
33
README.md
33
README.md
@ -365,6 +365,21 @@ How to use it:
|
|||||||
image: 7.jpg
|
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
|
### Images caption
|
||||||
|
|
||||||
|
|
||||||
@ -393,7 +408,25 @@ And on pictures-group
|
|||||||
- image5.jpg
|
- 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
|
### Example
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user