 |
Better readme - cl-yag - Common Lisp Yet Another website Generator |
 |
git clone git://bitreich.org/cl-yag/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws… |
 |
Log |
|
Files |
|
Refs |
|
Tags |
|
README |
|
LICENSE |
|
--- |
|
commit d69df0f848a3779e778330fe558bd60abcd832a7 |
|
parent 2266a8168f065f2b1311edee3999fcf9373cfaf7 |
|
Author: solene rapenne <[email protected]> |
|
Date: Fri, 20 May 2016 11:12:14 +0200 |
|
|
|
Better readme |
|
|
|
Diffstat: |
|
M README.md | 62 +++++++++++++++++++++--------… |
|
|
|
1 file changed, 43 insertions(+), 19 deletions(-) |
|
--- |
|
diff --git a/README.md b/README.md |
|
@@ -2,38 +2,56 @@ |
|
|
|
cl-yag stands for Common Lisp Yet Another Generator and obviously it's written… |
|
|
|
-It has only one dependency : a common lisp interpreter, I recommend both sbcl … |
|
+It has only one dependency : a common lisp interpreter. It is regularly tested… |
|
|
|
- |
|
-# The hierarchy |
|
+**This comes with a minimalistic template**, don't expect something good looki… |
|
+ |
|
+## The hierarchy |
|
|
|
Here are the files and folder of cl-yag : |
|
|
|
+ **Makefile** : exists to simplify your life (updating, cleaning) |
|
-+ **generator.lisp** : contains all the code of the generator |
|
-+ **templates/** : contains .tpl files which are used as template for the html… |
|
-+ **static/** : contains static files that need to be made public like images,… |
|
-+ **data/** : contains what will make the content of your website different fr… |
|
- + **articles.lisp** : contains metadata about the website and the list of th… |
|
- + **${id}.txt** : contains the html text of the article ${id} that will be u… |
|
-+ **output** : this is where the websites goes when your run *make*, and where… |
|
++ **generator.lisp** : contains all the code of the generator |
|
++ **templates/** : contains .tpl files which are used as template for the html… |
|
++ **static/** : contains the static files like images, css, js etc... that wil… |
|
++ **data/** : |
|
+ + **articles.lisp** : contains metadata about the website and the list of th… |
|
+ + **${id}.txt** : contains the html text of the article ${id} that will be u… |
|
++ **output** : folder where the website is generated when your run *make*. It … |
|
|
|
+# Usage |
|
+ |
|
+## How to add an article |
|
|
|
-# How to add an article |
|
- |
|
-Edit data/articles.lisp and add a new line inside the *articles* variable like… |
|
+Edit data/articles.lisp and add a new line inside the *articles* variable like… |
|
|
|
- (list :id "2" :date "29 April 2016" :title "How do I use cl-yag" :author "… |
|
+ (list :title "How do I use cl-yag" |
|
+ :id "2" :date "29 April 2016" |
|
+ :author "Solène" |
|
+ :short "I will explain how to use the generator" |
|
+ :tag "example help code") |
|
|
|
The _:short_ field is used on the homepage. It it is defined, this is the text… |
|
|
|
+The _:id_ field will be part of the filename of the file and it's also the nam… |
|
+ |
|
The _:author_ field is used to display who wrote the article. You can omitt it… |
|
|
|
-The _:tag_ field is used to create a page with all the articles with the same … |
|
+The _:tag_ field is used to create a page with all the articles with the same … |
|
+ |
|
+## How to publish |
|
+ |
|
+There is a makefile, all you need to do is to type "make" in the folder, this … |
|
|
|
-# How to hack it |
|
+Example with clisp : |
|
|
|
-I tried to make it "hacking friendly" so it's very extensible. |
|
+`make LISP=clisp` |
|
+ |
|
+This way, you can easily use a git hook to type make after each change in the … |
|
+ |
|
+# Some hacks you can do |
|
+ |
|
+I tried to make it "hacking friendly", you can extend if easily. If you have a… |
|
|
|
## Include some file in the template |
|
|
|
@@ -53,7 +71,7 @@ In **generate-site** function we can load a file, apply the t… |
|
|
|
(generate "somepage.html" (load-file "data/mypage.html")) |
|
|
|
-This will produce the file somepage.html in the output folder |
|
+This will produce the file **somepage.html** in the output folder. |
|
|
|
|
|
# How to use markdown for articles |
|
@@ -68,6 +86,12 @@ Here is a tip to produce html files from markdown using emacs |
|
|
|
The generator don't do it natively because I didn't want it to have dependenci… |
|
|
|
-# Known limitation |
|
+# Known limitations |
|
+ |
|
+## Use of ~ character |
|
|
|
The application will crash if you use a single "**~**" caracter inside one dat… |
|
+ |
|
+## Article without tag |
|
+ |
|
+You can have a page without a tag associated but in the default template you w… |
