bigchaindb
/
site
mirror of https://github.com/bigchaindb/site.git
1
0
Fork 0
Code Releases Activity

wording

This commit is contained in:
Matthias Kretschmann 2016-02-18 00:57:20 +01:00
parent ae79626e3d
commit 156fa58535
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/README.md
View File

@ -1,2 +1,3 @@
- [CSS](css.md)
- [Testimonials](testimonials.md)

20
docs/testimonials.md
View File

@ -3,13 +3,13 @@ Testimonials
The [testimonials component](../_src/_includes/testimonials.html)'s quotes are based on simple YAML data defined in [`_src/data/testimonials.yml`](../_src/data/testimonials.yml) with different arrays. Each array holds a total of 3 quotes.
So the testimonials component consists of various files:
The testimonials component consists of various files:
- [component](../_src/_includes/testimonials.html)
- [section](../_src/_includes/section-testimonials.html)
- [data](../_src/data/testimonials.yml)
- [styles](../_src/_assets/styles/bigchain/_testimonials.scss)
- [js](../_src/_assets/javascripts/bigchain/testimonials.js)
- [HTML component](../_src/_includes/testimonials.html)
- [HTML section](../_src/_includes/section-testimonials.html)
- [YAML data](../_src/data/testimonials.yml)
- [SCSS styles](../_src/_assets/styles/bigchain/_testimonials.scss)
- [JavaScript](../_src/_assets/javascripts/bigchain/testimonials.js)
### Photos
@ -25,14 +25,14 @@ Testimonials.init();
### Select and output a set of quotes
A set of quotes can be set as custom variable `quotes` in the YAML Front Matter of the page where the testimonials component has been included.
A set of quotes can be set as value of the custom variable `quotes` in the YAML Front Matter of the page where the testimonials component has been included.
E.g. on the frontpage [`_src/index.html`](../_src/index.html) we want to include the whole testimonials section and use `set3` for the quotes. So in the YAML Front Matter of that file, write:
E.g. on the front page [`_src/index.html`](../_src/index.html) we want to include the whole testimonials section and use `set2` for the quotes. So in the YAML Front Matter of that file, write:
```
---
quotes: set3
quotes: set2
---
```
@ -45,4 +45,4 @@ In the content of the page where you want to have the testimonials section inclu
</body>
```
The value of the `quotes` variable will grab the associated set of quotes and outputs them on the frontpage.
The value of the `quotes` variable will grab the associated set of quotes and outputs them on the front page.