commit ec61ee60dcbbe37b43d7cb6fb7a87bdfc847d990 lambda <lambda@fnord.one> 2017-11-24 11:48:28 +0100 Minor adjustments or README Checked for ambiguous usage of 'should' and 'could'. Deleted _ in :id Corrections of minor spelling errors. Status of this commit: PENDING
README.md | 6 +++--- data/README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md index 95f2cbe..8fdba0a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ## Introduction -cl-yag is a very lightweight, 'static site'-generator that produces **gopher** sites as well as **html** websites. +cl-yag is a very lightweight, static-site generator that produces **gopher** sites as well as **html** websites. The name 'cl-yag' stands for 'Common Lisp - Yet Another website Generator'. It runs without Quicklisp. @@ -143,13 +143,13 @@ The **config** variable is used to assign the following values: ### The **articles** Variable The **articles** variable holds per page/post-metadata. -Of the following fields, only the *:author* and *:short* description could be omitted. +Of the following fields, only the *:author* and *:short* description can be omitted. - **:short** - The _:short_ field's value is used for displaying a really short description of the posts content on your homepage. - If _:short_ doesn't get a value, the full article gets displayed. - Hint: Use ``:short "view the article for the full text"``, if you don't want to display the full text of an article on your index site. -- **:id_** +- **:id** - The _:id_ field holds the filename of your post/page. - Example: ``:id "2"`` will load file ``data/2.md``. Use text instead of numbers, if you want to. - (See section: 'The **data/** Directory'.) diff --git a/data/README.md b/data/README.md index 95f2cbe..8fdba0a 100644 --- a/data/README.md +++ b/data/README.md @@ -3,7 +3,7 @@ ## Introduction -cl-yag is a very lightweight, 'static site'-generator that produces **gopher** sites as well as **html** websites. +cl-yag is a very lightweight, static-site generator that produces **gopher** sites as well as **html** websites. The name 'cl-yag' stands for 'Common Lisp - Yet Another website Generator'. It runs without Quicklisp. @@ -143,13 +143,13 @@ The **config** variable is used to assign the following values: ### The **articles** Variable The **articles** variable holds per page/post-metadata. -Of the following fields, only the *:author* and *:short* description could be omitted. +Of the following fields, only the *:author* and *:short* description can be omitted. - **:short** - The _:short_ field's value is used for displaying a really short description of the posts content on your homepage. - If _:short_ doesn't get a value, the full article gets displayed. - Hint: Use ``:short "view the article for the full text"``, if you don't want to display the full text of an article on your index site. -- **:id_** +- **:id** - The _:id_ field holds the filename of your post/page. - Example: ``:id "2"`` will load file ``data/2.md``. Use text instead of numbers, if you want to. - (See section: 'The **data/** Directory'.)