Hashtagueule
/
htg-content
2
0
Fork 0
Code Issues Pull Requests 2 Releases Wiki Activity

better README

This commit is contained in:
raspbeguy 2020-05-11 17:42:24 +02:00
parent 1f4c117a60
commit 642b9d3b94
1 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -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.