 |
Fixing typo, one reported by Oliver Marugg - cl-yag - Common Lisp Yet Another w… |
 |
git clone git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws… |
 |
Log |
|
Files |
|
Refs |
|
Tags |
|
README |
|
LICENSE |
|
--- |
|
commit 23d6c036c8e4304b22492eaa231e68b509a5bedf |
|
parent dcbc55ff7e26410c8c8d7f06f68e1c0a246bcdd1 |
|
Author: Solene Rapenne <[email protected]> |
|
Date: Mon, 8 Mar 2021 13:16:30 +0100 |
|
|
|
Fixing typo, one reported by Oliver Marugg |
|
|
|
Diffstat: |
|
M README.md | 40 ++++++++++++++++-------------… |
|
|
|
1 file changed, 20 insertions(+), 20 deletions(-) |
|
--- |
|
diff --git a/README.md b/README.md |
|
@@ -31,9 +31,9 @@ To use cl-yag you'll need: |
|
## Usage |
|
|
|
Go into your project's directory and type ``make``. You'll find your new websi… |
|
-If you want to get rid of everything in your **output/** subdirectories, type … |
|
-For further commands: read the Makefile. |
|
-Read in the follwing section where to find it. |
|
+If you want to get rid of everything in your **output/** sub directories, type… |
|
+For further commands: read the Makefile. |
|
+Read in the following section where to find it. |
|
|
|
|
|
## Overview: cl-yag's File Hierarchy |
|
@@ -65,17 +65,17 @@ least the following files and folders: |
|
`-- rss.tpl |
|
|
|
- **Makefile** |
|
- - This file exists to simplifiy the recurring execution of frequently used… |
|
+ - This file exists to simplify the recurring execution of frequently used … |
|
- **generator.lisp** |
|
- This is cl-yag's core library. |
|
- **static/** |
|
- - This directory holds content, that needs to be published without being c… |
|
+ - This directory holds content, that needs to be published without being c… |
|
- If you come from 'non-static CMS'-Country: **static/** holds, what y… |
|
- **templates/** |
|
- - The templates in this directory provide the structural skeleton(s) of th… |
|
+ - The templates in this directory provide the structural skeleton(s) of th… |
|
- **output/** |
|
- cl-yag puts in this directory everything ready to get deployed. |
|
- - Because cl-yag generates not only HTML, but gopher-compliant pages a… |
|
+ - Because cl-yag generates not only HTML, but gopher-compliant pages a… |
|
- **gopher/** contains the website for gopher, |
|
- **html/** contains the website in HTML. |
|
|
|
@@ -87,7 +87,7 @@ This directory is crucial for the usage of cl-yag. |
|
|
|
**data/** contains |
|
|
|
-- the **articles.lisp** configuration file, which defines important metadata f… |
|
+- the **articles.lisp** configuration file, which defines important meta-data … |
|
- It also holds **${id}.md** files, which are holding your posts' (or pages') … |
|
|
|
For more information: Read section 'Configuration'. |
|
@@ -101,8 +101,8 @@ to set most of the values in this file. |
|
|
|
**data/articles.lisp** has two parts: |
|
|
|
-1. A variable called *config*. Its values define your webpage. |
|
-2. "posts" declaration with their metadata |
|
+1. A variable called *config*. Its values define your web page. |
|
+2. "posts" declaration with their meta-data |
|
|
|
Values are assigned by placing a string (e.g. ``"foo"``) or a boolean |
|
(i.e. ``t`` or ``nil``) behind a keyword (e.g. ``:title``). |
|
@@ -116,7 +116,7 @@ The *config* variable is used to assign the following value… |
|
- The name of the default(!) author. |
|
- ``:webmaster`` gets used, if ``:author`` is omitted. (See below: 'Th… |
|
- **:title** |
|
- - The title of the webpage |
|
+ - The title of the web-page |
|
- **:description** |
|
- This text is used in the *description* field of the atom/rss feed. |
|
- **:url** |
|
@@ -138,12 +138,12 @@ The *config* variable is used to assign the following val… |
|
- **gopher-format** |
|
- format of the gopher server. default is the geomyidae format, gophernicu… |
|
- **gopher-index** |
|
- - name of the gopher menu file. defaut is index.gph for geomyidae, gopherm… |
|
+ - name of the gopher menu file. default is index.gph for geomyidae, gopher… |
|
|
|
|
|
### Posts declarations |
|
|
|
-Each post is declared with its metadata using the function "post". |
|
+Each post is declared with its meta-data using the function "post". |
|
So you need to add a new line for each of your posts. |
|
|
|
Of the following keywords, only ``:author`` and ``:short`` can be omitted. |
|
@@ -152,12 +152,12 @@ Of the following keywords, only ``:author`` and ``:short`… |
|
- The ``:author`` field is used to display the article's author. |
|
- If you omit it, the generator will take the name from the ``:webmaster``… |
|
- **:id** |
|
- - The ``:id`` field holds the filename of your post/page. |
|
+ - The ``:id`` field holds the file name of your post/page. |
|
- Example: ``:id "2"`` will load file **data/2.md**. Use text instead … |
|
- (See section: 'The **data/** Directory'.) |
|
- **:tag** |
|
- ``:tag`` field is used to create a "view" containing all articles of the… |
|
- - MIND: Whitespaces are used to separate tags and are not allowed in(… |
|
+ - MIND: White spaces are used to separate tags and are not allowed in… |
|
- **:tiny** |
|
- The ``:tiny`` field's value is used for displaying a really short de… |
|
- If ``:tiny`` doesn't get a value, the full article gets displayed. |
|
@@ -166,7 +166,7 @@ Of the following keywords, only ``:author`` and ``:short`` … |
|
- The ``:title`` field's value sets your post's title, its first headl… |
|
|
|
|
|
-## Howto Create A New Post |
|
+## How-to Create A New Post |
|
|
|
Edit **data/articles.lisp** and add a new list to the *articles* variable: |
|
|
|
@@ -180,7 +180,7 @@ Edit **data/articles.lisp** and add a new list to the *arti… |
|
Then write a corresponding **data/2.md** file, using markdown. |
|
|
|
|
|
-## Howto Publish A Post |
|
+## How-to Publish A Post |
|
|
|
I prepared a Makefile to facilitate the process of generating and |
|
publishing your static sites. |
|
@@ -192,7 +192,7 @@ The default is the **output/** directory, but you can use a… |
|
pointing to some other directory as well. |
|
|
|
|
|
-## Howto Add A New Page |
|
+## How-to Add A New Page |
|
|
|
You may want to have some dedicated pages besides the index or a post. |
|
To create one, edit the *generate-site* function in cl-yag's |
|
@@ -205,7 +205,7 @@ This will produce **output/html/somepage.html**. |
|
|
|
## Further Customization |
|
|
|
-### Howto Use Another Common Lisp Interpreter |
|
+### How-to Use Another Common Lisp Interpreter |
|
|
|
cl-yags default Lisp interpreter is **sbcl**. If you want to use a |
|
different interpreter you need to set the variable *LISP* to the name |
|
@@ -260,7 +260,7 @@ displays: "Tags: ". |
|
|
|
### A Note On Themes |
|
|
|
-Although cl-yag may ship with a minimalistic template, cl-yag focuses |
|
+Although cl-yag may ship with a minimalist template, cl-yag focuses |
|
on generating html- and gopher-compliant structural markup - not |
|
themed layouts. |
|
