gabriel/tataslate
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

improve the link data file documentation

Browse Source
This commit is contained in:
Gus Esquivel 2017-05-18 17:53:14 -05:00
parent 6890f1fbdf
commit 9ba39af795
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -54,15 +54,22 @@ icon = "star" # font-awesome icon name
``` ```
Example : [config.toml](https://github.com/gesquive/slate/blob/master/config.toml) Example : [config.toml](https://github.com/gesquive/hugo-slate-demo/blob/master/config.toml)
## Links ## Links
All links are defined in the `data/links.yml` data file. All links are defined in the `data/links.yml` data file. Valid attributes are:
- **name**: the name displayed below the tile
- **url**: the url href, also used for text when no img is specified
- **tags**: (_optional_) list of tags to apply to this tile
- **img**: (_optional_) path to tile image, this will replace any text in the tile
- **txt_color**: (_optional_) css used to set the [`color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color) of a tile, a random value is chosen if none is specified
- **bg_color**: (_optional_) css used to set the [`background-color`](https://developer.mozilla.org/en-US/docs/Web/CSS/background-color) of a tile.
Example of link definitions in the data file. Example of link definitions in the data file.
``` yml ``` yaml
tiles: tiles:
- -
name: 'google' name: 'google'
@ -109,8 +116,7 @@ tiles:
img: 'pandora.svg' img: 'pandora.svg'
bg_color: '#005483' bg_color: '#005483'
txt_color: '#ffffff' txt_color: '#ffffff'
# tags: ['music'] tags: ['music']
``` ```
## Navigation ## Navigation
@ -145,5 +151,4 @@ icon = "shopping-basket"
name = "music" name = "music"
tag = "music" tag = "music"
icon = "headphones" icon = "headphones"
``` ```