hugo.soucy.cc

The personnal website source code of Hugo Soucy. Creates from an homebrewed static website generator (Ferron).
Log | Files | Refs

commit fa9a4f1dfa5d3eaf4502bb81e2b4f9a721251dc3
parent 1268053eaf3472a6872d05ef900cb2153bc1c15c
Author: Hugo Soucy <hugo.soucy@toumoro.com>
Date:   Sun,  9 Feb 2020 21:07:42 -0500

Works on documentation

Diffstat:
MDOC.md | 21+++++++++++++++------
1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/DOC.md b/DOC.md @@ -4,23 +4,32 @@ ### Le contenu (`content/`) -* Le contenu doit être en markdown/html avec l'extension `.md`. +* Le contenu doit être en **markdown/html** avec l'extension `.md`. * 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 de votre choix, contenant un fichier index: `mon-premier-repertoire/index.md`. + * La page `index.md` à la racine du répertoire `content/` est la + page d'accueil de votre site. + * À 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. * 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. + nom avec le fichier markdown; ce qui veut dire que, si votre page + s'appelle `ma-premiere-page.md`, dans le même répertoire vous devez + avoir un fichier de configuration qui s'appelle + `ma-premiere-page.{json,lua}`. * JSON est un format commun et pratique; on peut le parser, le convertir et générer facilement. Si malheureursement vous quittez Ferron pour un autre générateur de site statique, vous pourrez facilement porter vos données sans trop de soucis. - * Le principal avantage d'utiliser Lua pour vos métadonnées est que - vous pourrez créer des fonctions directement dans ces fichiers - pour manipuler plus finement votre contenu, ce qui n'est pas - possible avec le JSON. + * Sinon le principal avantage d'utiliser Lua pour vos métadonnées + est que vous pourrez créer des fonctions directement dans ces + fichiers pour manipuler plus finement votre contenu, ce qui n'est + pas possible avec le JSON. * Dans un même site rien ne vous empêche d'alterner les formats selon vos besoins. Toutefois, veuillez noter que le format Lua aura priorité si deux fichiers de configuration sont présent pour