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

Refurbish README

This commit is contained in:
lambda 2017-12-03 16:02:54 +01:00
parent aa1264695d 15ebe730f3
commit bd44af1d08
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -117,7 +117,7 @@ The *config* variable is used to assign the following values:
- **:title**
- The title of the webpage
- **:description**
- This text is used in the *description* field of the Atom RSS
- This text is used in the *description* field of the atom/rss feed.
- **:url**
- This needs to be the full(!) URL of your website, including(!) a final slash.
- MIND: If the url contains a tilde (~), it needs to get duplicated
@ -150,13 +150,13 @@ Of the following keywords, only ``:author`` and ``:short`` can be omitted.
- 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'.)
- **: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.
- **:tag**
- ``:tag`` field is used to create a "view" containing all articles of the same tag.
- MIND: Whitespaces are used to separate tags and are not allowed in(!) tags.
- **:tiny**
- The ``:tiny`` field's value is used for displaying a really short description of the posts content on your homepage.
- If ``:tiny`` doesn't get a value, the full article gets displayed.
- Hint: Use ``:tiny "Read the full article for more information."``, if you don't want to display the full text of an article on your index site.
- **:title**
- The ``:title`` field's value sets your post's title, its first headline, as well as its entry on the index.html.

10
data/README.md
View File

@ -117,7 +117,7 @@ The *config* variable is used to assign the following values:
- **:title**
- The title of the webpage
- **:description**
- This text is used in the *description* field of the Atom RSS
- This text is used in the *description* field of the atom/rss feed.
- **:url**
- This needs to be the full(!) URL of your website, including(!) a final slash.
- MIND: If the url contains a tilde (~), it needs to get duplicated
@ -150,13 +150,13 @@ Of the following keywords, only ``:author`` and ``:short`` can be omitted.
- 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'.)
- **: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.
- **:tag**
- ``:tag`` field is used to create a "view" containing all articles of the same tag.
- MIND: Whitespaces are used to separate tags and are not allowed in(!) tags.
- **:tiny**
- The ``:tiny`` field's value is used for displaying a really short description of the posts content on your homepage.
- If ``:tiny`` doesn't get a value, the full article gets displayed.
- Hint: Use ``:tiny "Read the full article for more information."``, if you don't want to display the full text of an article on your index site.
- **:title**
- The ``:title`` field's value sets your post's title, its first headline, as well as its entry on the index.html.