nonlinear
/
www-gopher
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
lambda 2017-11-24 11:48:28 +01:00
parent 561ae0469c
commit 5024296da2
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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'.)

6
data/README.md
View File

@ -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'.)