From 642b9d3b94c4a17e1a5bcfdfdaab934bda94eea7 Mon Sep 17 00:00:00 2001 From: raspbeguy Date: Mon, 11 May 2020 17:42:24 +0200 Subject: [PATCH] better README --- README.md | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index de42086..b958421 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,37 @@ -# Contenu du blog Hashtagueule +--- +title: Contenu du blog Hashtagueule +--- # Pour les rédacteurs -Pour publier, il suffit de pousser. +## Organisation -* Dans `content` : texte uniquement, posts à placer dans `content/posts`. -* Dans `assets` : tous les fichiers média en utilisant LFS. +- Dans `content` : texte uniquement, posts à placer dans `content/posts`. +- Dans `assets` : tous les fichiers média en utilisant LFS. + +## Éléments syntaxiques + +### En-tête + +L'en-tête contient les métodonnées de l'article et se présente sous la forme suivante : + +``` +--- +title: Super article +date: 2020-05-11 +author: raspbeguy +template: post +tags: tutoriel,news,tribune +--- +``` + +- __Le titre__ est obligatoire. +- __La date__ doit être sous le format `%Y-%m-%d` et est obligatoire. +- __L'auteur__ est obligatoire. +- __Le modèle__ (_template_) doit obligatoirement correspondre à `post`. +- __La liste de tags__ est facultative (mais recommandée) et se compose d'une liste à virgule. + +### Images Pour placer un média dans un article, utiliser le mot-clé `%assets_url%`. @@ -15,6 +41,10 @@ Par exemple, pour insérer l'image `assets/image.png`, on placera cette ligne da ![](%assets_url%/image.png) ``` +## Publication + +Pour publier, il suffit de pousser. + # Pour l'administrateur système Pour installer, cloner le dépôt quelque part, puis faire des liens symboliques de `content` et `assets` dans le dossier racine d'une installation PicoCMS.