iFix spaces at end of line - cl-yag - Common Lisp Yet Another website Generator Err bitreich.org 70
hgit clone git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/cl-yag/ URL:git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/cl-yag/ bitreich.org 70
1Log /scm/cl-yag/log.gph bitreich.org 70
1Files /scm/cl-yag/files.gph bitreich.org 70
1Refs /scm/cl-yag/refs.gph bitreich.org 70
1Tags /scm/cl-yag/tag bitreich.org 70
1README /scm/cl-yag/file/README.md.gph bitreich.org 70
1LICENSE /scm/cl-yag/file/LICENSE.gph bitreich.org 70
i--- Err bitreich.org 70
1commit 25c83f1ce1ad0e39f746364c88ce45fda78e4630 /scm/cl-yag/commit/25c83f1ce1ad0e39f746364c88ce45fda78e4630.gph bitreich.org 70
1parent 8f68de9add9b35be4694980db5826a91e286cf7b /scm/cl-yag/commit/8f68de9add9b35be4694980db5826a91e286cf7b.gph bitreich.org 70
hAuthor: Solene Rapenne <solene@perso.pw> URL:mailto:solene@perso.pw bitreich.org 70
iDate: Tue, 28 Nov 2017 08:15:42 +0100 Err bitreich.org 70
i Err bitreich.org 70
iFix spaces at end of line Err bitreich.org 70
i Err bitreich.org 70
iDiffstat: Err bitreich.org 70
i M README.md | 125 +++++++++++++++---------------- Err bitreich.org 70
i Err bitreich.org 70
i1 file changed, 62 insertions(+), 63 deletions(-) Err bitreich.org 70
i--- Err bitreich.org 70
1diff --git a/README.md b/README.md /scm/cl-yag/file/README.md.gph bitreich.org 70
i@@ -3,17 +3,16 @@ Err bitreich.org 70
i Err bitreich.org 70
i ## Introduction Err bitreich.org 70
i Err bitreich.org 70
i-cl-yag is a very lightweight, 'static site'-generator that produces **gopher** sites as well as **html** websites. Err bitreich.org 70
i-The name 'cl-yag' stands for 'Common Lisp - Yet Another website Generator'. Err bitreich.org 70
i+cl-yag is a very lightweight, 'static site'-generator that produces **gopher** sites as well as **html** websites. Err bitreich.org 70
i+The name 'cl-yag' stands for 'Common Lisp - Yet Another website Generator'. Err bitreich.org 70
i It runs without Quicklisp. Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i ## Showcase Err bitreich.org 70
i Err bitreich.org 70
i I am using cl-yag to create and maintain my websites in the Err bitreich.org 70
i-world-wide-web (visit: *[Solene's Err bitreich.org 70
i-percent](https://dataswamp.org/~solene/)*) as well as [in Err bitreich.org 70
i-gopher-space](gopher://dataswamp.org/1/~solene/). Err bitreich.org 70
i+world-wide-web (visit: *[Solene'spercent](https://dataswamp.org/~solene/)*) Err bitreich.org 70
i+as well as [in gopher-space](gopher://dataswamp.org/1/~solene/). Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i ## Requirements Err bitreich.org 70
i@@ -32,10 +31,10 @@ To use cl-yag you'll need: Err bitreich.org 70
i Err bitreich.org 70
i ## Usage Err bitreich.org 70
i Err bitreich.org 70
i-Go into your project's directory and type ``make``. You'll find your new website/gopher page in 'output/'. Err bitreich.org 70
i+Go into your project's directory and type ``make``. You'll find your new website/gopher page in 'output/'. Err bitreich.org 70
i If you want to get rid of everything in your 'output/' subdirectories, Err bitreich.org 70
i-type ``make clean``. Err bitreich.org 70
i-For further commands: read the Makefile. Err bitreich.org 70
i+type ``make clean``. Err bitreich.org 70
i+For further commands: read the Makefile. Err bitreich.org 70
i Read in the follwing section where to find it. Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i@@ -44,28 +43,28 @@ Read in the follwing section where to find it. Err bitreich.org 70
i After cloning the repository, your project's directory should contain at Err bitreich.org 70
i least the following files and folders: Err bitreich.org 70
i Err bitreich.org 70
i- . Err bitreich.org 70
i- |-- LICENSE Err bitreich.org 70
i- |-- Makefile Err bitreich.org 70
i- |-- README.md Err bitreich.org 70
i- |-- data/ Err bitreich.org 70
i- | |-- 1.md Err bitreich.org 70
i- | |-- README.md Err bitreich.org 70
i- | `-- articles.lisp Err bitreich.org 70
i- |-- generator.lisp Err bitreich.org 70
i- |-- output/ Err bitreich.org 70
i- | |-- gopher/ Err bitreich.org 70
i- | `-- html/ Err bitreich.org 70
i- |-- static/ Err bitreich.org 70
i- | |-- css/style.css Err bitreich.org 70
i- | `-- img/ Err bitreich.org 70
i- `-- templates/ Err bitreich.org 70
i- |-- article.tpl Err bitreich.org 70
i- |-- gopher_head.tpl Err bitreich.org 70
i- |-- layout.tpl Err bitreich.org 70
i- |-- one-tag.tpl Err bitreich.org 70
i- |-- rss-item.tpl Err bitreich.org 70
i- `-- rss.tpl Err bitreich.org 70
i+. Err bitreich.org 70
i+ |-- LICENSE Err bitreich.org 70
i+ |-- Makefile Err bitreich.org 70
i+ |-- README.md Err bitreich.org 70
i+ |-- data/ Err bitreich.org 70
i+ | |-- 1.md Err bitreich.org 70
i+ | |-- README.md Err bitreich.org 70
i+ | `-- articles.lisp Err bitreich.org 70
i+ |-- generator.lisp Err bitreich.org 70
i+ |-- output/ Err bitreich.org 70
i+ | |-- gopher/ Err bitreich.org 70
i+ | `-- html/ Err bitreich.org 70
i+ |-- static/ Err bitreich.org 70
i+ | |-- css/style.css Err bitreich.org 70
i+ | `-- img/ Err bitreich.org 70
i+ `-- templates/ Err bitreich.org 70
i+ |-- article.tpl Err bitreich.org 70
i+ |-- gopher_head.tpl Err bitreich.org 70
i+ |-- layout.tpl Err bitreich.org 70
i+ |-- one-tag.tpl Err bitreich.org 70
i+ |-- rss-item.tpl Err bitreich.org 70
i+ `-- rss.tpl Err bitreich.org 70
i Err bitreich.org 70
i - **Makefile** Err bitreich.org 70
i - This file exists to simplifiy the recurring execution of frequently used commands. Err bitreich.org 70
i@@ -73,14 +72,14 @@ least the following files and folders: Err bitreich.org 70
i - This is cl-yag's core library. Err bitreich.org 70
i - **static/** Err bitreich.org 70
i - This directory holds content, that needs to be published without being changed (e.g. stylesheets, js-scripts). Err bitreich.org 70
i- - If you come from 'non-static CMS'-Country: 'static/' holds, what you would put in your 'assets/' directory. Err bitreich.org 70
i+ - If you come from 'non-static CMS'-Country: 'static/' holds, what you would put in your 'assets/' directory. Err bitreich.org 70
i - **templates/** Err bitreich.org 70
i - The templates in this directory provide the structural skeleton(s) of the webpages and feeds you want to create. Err bitreich.org 70
i - **output/** Err bitreich.org 70
i - cl-yag puts in this directory everything ready to get deployed. Err bitreich.org 70
i- - Because cl-yag generates not only HTML, but gopher-compliant pages as well, output/ **holds two subdirectories**. Err bitreich.org 70
i- - **gopher/** : contains the website for gopher, Err bitreich.org 70
i- - **html/** : contains the website in HTML. Err bitreich.org 70
i+ - Because cl-yag generates not only HTML, but gopher-compliant pages as well, output/ **holds two subdirectories**. Err bitreich.org 70
i+ - **gopher/** : contains the website for gopher, Err bitreich.org 70
i+ - **html/** : contains the website in HTML. Err bitreich.org 70
i Err bitreich.org 70
i And there is the **data/** directory, which is important enough to get a subsubsection of its own. Err bitreich.org 70
i Err bitreich.org 70
i@@ -117,15 +116,15 @@ The **config** variable is used to assign the following values: Err bitreich.org 70
i Err bitreich.org 70
i - **:webmaster** Err bitreich.org 70
i - The name of the default(!) author. Err bitreich.org 70
i- - :webmaster gets used, if **:author** is omitted. (see below: 'The **articles** variable'.) Err bitreich.org 70
i+ - :webmaster gets used, if **:author** is omitted. (see below: 'The **articles** variable'.) Err bitreich.org 70
i - **:title** Err bitreich.org 70
i - The title of the webpage Err bitreich.org 70
i - **:description** Err bitreich.org 70
i - This text is used in the *description* field of the Atom RSS Err bitreich.org 70
i - **:url** Err bitreich.org 70
i - This needs to be the full(!) URL of your website, including(!) a final slash. Err bitreich.org 70
i- - MIND: If the url contains a tilde (~), it needs to get duplicated Err bitreich.org 70
i- - Example: https://mydomain/~~user/ is a valid url. Err bitreich.org 70
i+ - MIND: If the url contains a tilde (~), it needs to get duplicated Err bitreich.org 70
i+ - Example: https://mydomain/~~user/ is a valid url. Err bitreich.org 70
i - **:rss-item-number** Err bitreich.org 70
i - This holds the number of latest(!) RSS items you want to get published when you generate the files. Err bitreich.org 70
i - **html** Err bitreich.org 70
i@@ -142,35 +141,35 @@ The **config** variable is used to assign the following values: Err bitreich.org 70
i Err bitreich.org 70
i ### The **articles** Variable Err bitreich.org 70
i Err bitreich.org 70
i-The **articles** variable holds per page/post-metadata. Err bitreich.org 70
i+The **articles** variable holds per page/post-metadata. Err bitreich.org 70
i Of the following fields, only the *:author* and *:short* description could be omitted. Err bitreich.org 70
i Err bitreich.org 70
i - **:short** Err bitreich.org 70
i- - The _:short_ field's value is used for displaying a really short description of the posts content on your homepage. Err bitreich.org 70
i- - If _:short_ doesn't get a value, the full article gets displayed. Err bitreich.org 70
i- - 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. Err bitreich.org 70
i+ - The _:short_ field's value is used for displaying a really short description of the posts content on your homepage. Err bitreich.org 70
i+ - If _:short_ doesn't get a value, the full article gets displayed. Err bitreich.org 70
i+ - 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. Err bitreich.org 70
i - **:id_** Err bitreich.org 70
i- - The _:id_ field holds the filename of your post/page. Err bitreich.org 70
i- - Example: ``:id "2"`` will load file ``data/2.md``. Use text instead of numbers, if you want to. Err bitreich.org 70
i- - (See section: 'The **data/** Directory'.) Err bitreich.org 70
i+ - The _:id_ field holds the filename of your post/page. Err bitreich.org 70
i+ - Example: ``:id "2"`` will load file ``data/2.md``. Use text instead of numbers, if you want to. Err bitreich.org 70
i+ - (See section: 'The **data/** Directory'.) Err bitreich.org 70
i - **:author** Err bitreich.org 70
i - The _:author_ field is used to display the article' author. Err bitreich.org 70
i - If you omit it, the generator will take the name from the **:webmaster** field of the *config* variable. Err bitreich.org 70
i - **:tag** Err bitreich.org 70
i - _:tag_ field is used to create a "view" containing all articles of the same tag. Err bitreich.org 70
i- - MIND: Whitespaces are not allowed in(!) tags. Err bitreich.org 70
i+ - MIND: Whitespaces are not allowed in(!) tags. Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i ## Howto Create A New Post Err bitreich.org 70
i- Err bitreich.org 70
i+ Err bitreich.org 70
i Edit data/articles.lisp and add a new list to the *articles* variable: Err bitreich.org 70
i Err bitreich.org 70
i- (list :title "How do I use cl-yag" Err bitreich.org 70
i- :id "2" Err bitreich.org 70
i- :date "29 April 2016" Err bitreich.org 70
i- :author "Solène" Err bitreich.org 70
i- :short "I will explain how to use the generator" Err bitreich.org 70
i- :tag "example help code") Err bitreich.org 70
i+ (list :title "How do I use cl-yag" Err bitreich.org 70
i+ :id "2" Err bitreich.org 70
i+ :date "29 April 2016" Err bitreich.org 70
i+ :author "Solène" Err bitreich.org 70
i+ :short "I will explain how to use the generator" Err bitreich.org 70
i+ :tag "example help code") Err bitreich.org 70
i Err bitreich.org 70
i Then write a corresponding ``2.md`` file, using markdown. Err bitreich.org 70
i Err bitreich.org 70
i@@ -189,12 +188,12 @@ other directory, somewhere else on your machine). Err bitreich.org 70
i Err bitreich.org 70
i ## Howto Add A New Page Err bitreich.org 70
i Err bitreich.org 70
i-You may want to have some dedicated pages besides the index or a post. Err bitreich.org 70
i+You may want to have some dedicated pages besides the index or a post. Err bitreich.org 70
i To create one, edit the **generate-site** function in cl-yag's Err bitreich.org 70
i generator.lisp and add a function call, like this: Err bitreich.org 70
i Err bitreich.org 70
i (generate "somepage.html" (load-file "data/mypage.html")) Err bitreich.org 70
i- Err bitreich.org 70
i+ Err bitreich.org 70
i This will produce the file **somepage.html** in the output folder. Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i@@ -202,11 +201,11 @@ This will produce the file **somepage.html** in the output folder. Err bitreich.org 70
i Err bitreich.org 70
i ### Howto Use Another Common Lisp Interpreter Err bitreich.org 70
i Err bitreich.org 70
i-cl-yags default Lisp interpreter is **sbcl**. Err bitreich.org 70
i+cl-yags default Lisp interpreter is **sbcl**. Err bitreich.org 70
i If you want to use a different lisp interpreter you need to set the Err bitreich.org 70
i variable 'LISP' to the name of your binary, when calling ``make``. Err bitreich.org 70
i Err bitreich.org 70
i- `make LISP=ecl` Err bitreich.org 70
i+ make LISP=ecl Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i ### Using git Hooks For Publishing Err bitreich.org 70
i@@ -221,13 +220,13 @@ updated automatically. Err bitreich.org 70
i Here is an example code, if you want to include another page in the template: Err bitreich.org 70
i Err bitreich.org 70
i 1. Create **template/panel.tpl** with the html you want to include. Err bitreich.org 70
i-2. Add a string in the target file, where the replacement should occur. Err bitreich.org 70
i+2. Add a string in the target file, where the replacement should occur. Err bitreich.org 70
i In this case, we choose **%%Panel%%** for a string, and, because we want the panel to be displayed on each page, we add this string to **template/layout.tpl**. Err bitreich.org 70
i Err bitreich.org 70
i-3. Modify the function *generate-layout* in cl-yag's **generator.lisp** accordingly. Err bitreich.org 70
i+3. Modify the function *generate-layout* in cl-yag's **generator.lisp** accordingly. Err bitreich.org 70
i This is done by adding the following template function call: Err bitreich.org 70
i Err bitreich.org 70
i- "**(template "%%Panel%%" (load-file "template/panel.tpl"))**" Err bitreich.org 70
i+ (template "%%Panel%%" (load-file "template/panel.tpl")) Err bitreich.org 70
i Err bitreich.org 70
i (Note: You can insert your text directly into the layout template file Err bitreich.org 70
i as well.) Err bitreich.org 70
i@@ -243,7 +242,7 @@ tilde as a prefix to indicate format specifiers in format strings. Err bitreich.org 70
i Err bitreich.org 70
i In order to use a literal `~` - e.g. for creating a :title or :url Err bitreich.org 70
i reference - you have to **escape** the tilde **by duplicating** it: Err bitreich.org 70
i-``~~``. Err bitreich.org 70
i+``~~``. Err bitreich.org 70
i (See _:url_ in section 'Configuration'). Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i@@ -262,17 +261,17 @@ focuses only on generating html- and gopher-compliant structural Err bitreich.org 70
i markup - not themed layouts. Err bitreich.org 70
i Err bitreich.org 70
i If you want some deeply refined, cross-browser compatible, responsive, Err bitreich.org 70
i-webscale style-sheet, you need to create it yourself. Err bitreich.org 70
i+webscale style-sheet, you need to create it yourself. Err bitreich.org 70
i However, cl-yag will work nicely with it and if you want to make your Err bitreich.org 70
i stylesheets a part of cl-yag you're very welcome to contact me. Err bitreich.org 70
i Err bitreich.org 70
i Err bitreich.org 70
i # Hacking cl-yag Err bitreich.org 70
i Err bitreich.org 70
i-I tried to make cl-yag easy to extend. Err bitreich.org 70
i+I tried to make cl-yag easy to extend. Err bitreich.org 70
i If you want to contribute, feel free to contact me and/or to send in a patch. Err bitreich.org 70
i Err bitreich.org 70
i - If you are looking for a way to contribute: Err bitreich.org 70
i - You could find a way to "sanitize" cl-yag's behaviour regarding the tilde (see: above); Err bitreich.org 70
i - Also see: 'Note' in 'Posting Without Tagging'; Err bitreich.org 70
i- - Also see: 'A Note On Themes. Err bitreich.org 70
i+ - Also see: 'A Note On Themes. Err bitreich.org 70
.
Response:
text/plain