complete README
This commit is contained in:
parent
bb35566388
commit
76bf8e2c27
15
README.md
15
README.md
|
@ -27,6 +27,12 @@ tags: tutoriel,news,tribune
|
|||
- __Le modèle__ (_template_) doit obligatoirement correspondre à `post`.
|
||||
- __La liste de tags__ est facultative (mais recommandée) et se compose d'une liste à virgule de mots en minuscules.
|
||||
|
||||
Par ailleurs, le nom de fichier d'un post doit correspondre à la version sécurisée du champ `title`, c'est à dire :
|
||||
|
||||
- en minuscules ;
|
||||
- sans diacritiques ;
|
||||
- chaque caractère spécial et espace remplacé par un tiret `-` non redondant, ni au début ni à la fin.
|
||||
|
||||
### Images
|
||||
|
||||
Pour placer un média dans un article, utiliser le mot-clé `%assets_url%`.
|
||||
|
@ -37,6 +43,15 @@ Par exemple, pour insérer l'image `assets/image.png`, on placera cette ligne da
|
|||
![](%assets_url%/image.png)
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
Pour vérifier la cohérence des articles, des scripts sont disponibles dans le dossier `tests` :
|
||||
|
||||
- `check_post_filename.sh` : vérifie que les fichiers des posts portent bien le nom correspondant à leurs titres. Le drapeau `-f` permet de corriger automatiquement ce nom de fichier.
|
||||
- `check_assets.sh` : vérifie que les ressources appelées par les posts existent bien dans le dossier `assets`.
|
||||
|
||||
Utilisés sans arguments, ces scripts vérifient l'ensemble des articles. Avec un argument, les scripts ne vérifient que le post dont l'argument est le nom de fichier.
|
||||
|
||||
## Publication
|
||||
|
||||
Pour publier, il suffit de pousser.
|
||||
|
|
Loading…
Reference in New Issue