From 156fa585355906dd6ad5cc0fb15b2db3afde8060 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Thu, 18 Feb 2016 00:57:20 +0100 Subject: [PATCH] wording --- docs/README.md | 1 + docs/testimonials.md | 20 ++++++++++---------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8b03d6c..0ca569f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,3 @@ - [CSS](css.md) +- [Testimonials](testimonials.md) diff --git a/docs/testimonials.md b/docs/testimonials.md index bf6df8a..daa0de9 100644 --- a/docs/testimonials.md +++ b/docs/testimonials.md @@ -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 ``` -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.