update doc and exemple
This commit is contained in:
parent
9f51abaeaf
commit
5aa2f4f96b
32
README.md
32
README.md
@ -63,20 +63,34 @@ It is possible to add a menu to your homepage that links to static pages. To do
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
menu:
|
menu:
|
||||||
- about: "About Me"
|
name: "About"
|
||||||
- contact: "Contact"
|
type: "page"
|
||||||
|
url: "about"
|
||||||
|
- name: "My first gallery"
|
||||||
|
type: "folder"
|
||||||
|
url: "first_gallery"
|
||||||
|
- name: "Twitter"
|
||||||
|
type: "external"
|
||||||
|
url: "http://twitter.com"
|
||||||
```
|
```
|
||||||
|
|
||||||
The first part (`about` and `contact`) here are the name of the files (without
|
You can use 3 type of item in the menu:
|
||||||
the `.yaml`) and the second part are the menu title that will be displayed in
|
|
||||||
the templates. So, here, you'll need to create a ``about.yaml`` and a
|
|
||||||
``contact.yaml`` files in the root directory. Their content are similar to
|
|
||||||
galleries (see [bellow](#gallery-settingsyaml)).
|
|
||||||
|
|
||||||
For example, this could be the content of `contact.yaml`:
|
* page
|
||||||
|
* folder
|
||||||
|
* external
|
||||||
|
|
||||||
|
For page, the url is the files (without the `.yaml`)
|
||||||
|
For folder, the url is the name of the folder (like first_gallery in exemple)
|
||||||
|
And for the external, the url is the full url of the website. You can
|
||||||
|
use it too for make home in the menu.
|
||||||
|
So, here, you'll need to create a ``about.yaml`` files in the root directory.
|
||||||
|
Their content are similar to galleries (see [bellow](#gallery-settingsyaml)).
|
||||||
|
|
||||||
|
For example, this could be the content of `about.yaml`:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
title: "Contact"
|
title: "About"
|
||||||
sections:
|
sections:
|
||||||
- type: text
|
- type: text
|
||||||
text: Some text, HTML <b>is allowed</b>.
|
text: Some text, HTML <b>is allowed</b>.
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
title: "Menu 2"
|
|
||||||
sections:
|
|
||||||
- type: text
|
|
||||||
text: « voici plein de blabla à rajouter et <b>ceci est du gras</b> et encore plein plein plein plein de text car je veux voir comment ça va wrapper car c'est important et il faut pas que j'oublie de mettre des margins en % sinon ça va pas le faire alala là ça devrait aller »
|
|
||||||
|
|
@ -1,4 +1,11 @@
|
|||||||
title: "Example gallery"
|
title: "Example gallery"
|
||||||
menu:
|
menu:
|
||||||
- about: "Menu 1"
|
- name: "About"
|
||||||
- contact: "Menu 2"
|
type: "page"
|
||||||
|
url: "about"
|
||||||
|
- name: "My first gallery"
|
||||||
|
type: "folder"
|
||||||
|
url: "first_gallery"
|
||||||
|
- name: "Twitter"
|
||||||
|
type: "external"
|
||||||
|
url: "http://twitter.com"
|
||||||
|
Loading…
x
Reference in New Issue
Block a user