 |
Adding 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 4df8123e33dce1823b28195c473a4a465eca4726 |
|
parent 66a2b83f5bceef484963bd78efc2a2da98004f4e |
|
Author: Solene Rapenne <[email protected]> |
|
Date: Sat, 30 Apr 2016 17:28:12 +0200 |
|
|
|
Adding readme |
|
|
|
Diffstat: |
|
A README | 54 +++++++++++++++++++++++++++++… |
|
|
|
1 file changed, 54 insertions(+), 0 deletions(-) |
|
--- |
|
diff --git a/README b/README |
|
@@ -0,0 +1,54 @@ |
|
+Introduction |
|
+=== |
|
+ |
|
+This blog is generated using cl-yag. It stands for Common Lisp Yet Another Gen… |
|
+ |
|
+It has only one dependency : a common lisp interpreter, I recommend both sbcl … |
|
+ |
|
+ |
|
+The hierarchy |
|
+=== |
|
+ |
|
+Here are the files and folder you can find in your project folder : |
|
+ |
|
+ |
|
+ |
|
+- **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… |
|
+ |
|
+ |
|
+How to add an article |
|
+=== |
|
+ |
|
+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 "Sol�… |
|
+``` |
|
+ |
|
+The _:short_ field is used on the homepage. It it is defined, this is the text… |
|
+ |
|
+The _:author_ field is used to display who wrote the article. You can omitt it… |
|
+ |
|
+ |
|
+How to use markdown for articles |
|
+=== |
|
+ |
|
+Here is a tip to produce html files from markdown using emacs |
|
+ |
|
+ |
|
+ |
|
+ |
|
+1. edit the article file with emacs using ham-mode (which is html) |
|
+2. write your text with markdown syntax |
|
+3. save your file (ham-mode will convert it to html inside) |
|
+4. *make* to update your site |
|
+ |
|
+The generator do not do it natively because I do not want it to have dependenc… |
