commit bae31ddb572dbaf765b069b2f15188831870bc07
parent 914cb111423642aa3e83fb4df37a30baed27f85e
Author: Hugo Soucy <hugo.soucy@toumoro.com>
Date: Mon, 10 Feb 2020 19:32:45 -0500
Update ferron documentation
Diffstat:
| M | DOC.md | | | 25 | +++++++++++++++++++++---- |
1 file changed, 21 insertions(+), 4 deletions(-)
diff --git a/DOC.md b/DOC.md
@@ -1,10 +1,22 @@
-# Documentation
+Documentation
+=============
-## Les bases
+Introduction
+------------
+
+Ferron est un générateur de site statique (SSG) écrit avec le langage
+de programmation [Lua](https://lua.org/).
+
+Les bases
+---------
### Le contenu (`content/`)
-* Le contenu doit être en **markdown/html** avec l'extension `.md`.
+* Le contenu doit être en **markdown/html**
+ (https://daringfireball.net/projects/markdown/) avec l'extension
+ `.md`. La librairie
+ [lua-discount](http://asbradbury.org/projects/lua-discount/) est
+ utilisé par Ferron pour convertir le markdown en HTML.
* Pour une page simple aucun répertoire est nécessaire:
`ma-premiere-page.md`, `ma-seconde-page.md`, etc.
* Pour une page de type index, vous créez un répertoire avec le nom
@@ -15,7 +27,8 @@
* À partir d'une page `index.md`, vous avez accès au contenu de
toutes les autres pages de même niveau ou des niveaux
inférieurs. Ce qui vous permet de créer granulairement des listes
- de contenus.
+ de contenus assez complètes à partir de n'importe où dans
+ l'arborescence.
* Les métadonnées (configuration) d'une page sont à part dans un
fichier avec l'extension `.json` ou `.lua`; celui-ci est lié par le
nom avec le fichier markdown; ce qui veut dire que, si votre page
@@ -43,6 +56,10 @@
Mustache. Mais j'ai comme projet d'en utiliser un deuxième qui
permettra d'intégrer de la logique directement dans les templates,
ce que Mustache ne permet pas.
+
+ Pour ce faire je vais proprement permettre directement l'utilsation
+ du Lua, vue que celui-ci possède une syntaxe bien plus simple que la
+ plupart des langages de template.
* Les fichiers Mustache doivent porter l'extension `.mustache`.
* Les templates des flux de syndication tels que ATOM, RSS ou JSON
Feed doivent être dans un sous-répertoire nommé `feed/`.
