# Comment écrire un article ?


## Avant-propos
Avant de vous expliquer en détail comment écrire un article (screens plus bas), je pense qu'il est meilleur de comprendre les outils sur lesquels on travaille: 

**Prose.io** est un outil d'écriture et de mise en forme de l'architecture des dossiers qui servent a la génération du site. L'outil ne fait rien de plus que de faire un bel affichage des fichiers et de leurs propriétées.

L'affichage des meta-données (propriétées de la page) est contrôlé par un fichier de configuration se trouvant à la racine du site : _prose.yml. Je peux éditer ce fichier pour ajouter / retirer / modifier les entêtes des documents si besoin en suivant les indications de [cette documentation](https://github.com/prose/prose/wiki/Prose-Configuration#options)

Github, le site sur lequel vous avez dû vous connecter pour accéder au dossier depuis prose.io, est un site fait pour les développeurs permettant d'hébérger un dossier, et contenant des fonctions permettant par exemple d'historiser les versions du dossier a chaque modification (permettant de revenir en arrière au besoin) ou encore d'executer des script à chaque modification détéctée

Cet outil est très complet et pour le comprendre il faut comprendre Git. Je vous laisse vous renseigner au besoin, mais ce que vous avez besoin de savoir c'est qu'une fois le contenu modifié sur Prose, c'est le contenu du dossier sur github qui est modifié

Un automatisme s'active alors, regénérant le site et l'envoyant de nouveau sur l'adresse du site internet. Si la régénération échoue, le site ne sera pas mis à jour.

Hugo est le framework (outil) qui nous permet de construire le site. Pour que Hugo fonctionne, il faut respecter ses pré-requis et son fonctionnement. Les voici : 
- Les fichiers présents dans _/content_ créent des pages ou des listes aux adresses indiquées (content/jeux/dofus/index.md -> meridian-corp.org/content/jeux/dofus)
- Les page seules sont créées a partir des fichiers 'index.md' tandis que les listes de page sont créées a partir des fichiers '_index.md'
- Les en-têtes des fichiers doivent être renseignées sans quoi les pages ne seront pas publiées
- Le corps de texte peut être écrit en markdown ou bien en html
- Hugo lit le système de fichier pour comprendre l'architecture attendue du site, puis transforme les fichier markdown en page html d'après un modèle mettant en page les informations et le corps de texte

## Ecrire un article 
Pour écrire un article sur le site :
1 - Ouvrez le dossier 'content' dans lequel on trouve les pages du site 
![]({{site.baseurl}}/assets/images/readme/content.png)
2 - Trouvez le dossier de contenu que vous voulez. Prenons posts par exemple, vous trouverez d'autres dossier, 1 par article, et un fichier _index.md indiquant bien que c'est une page liste
3 - Créez un "new file" grâce au bouton en haut de l'écran.
![]({{site.baseurl}}/assets/images/readme/new_file.png)
4 - Renommez le nom du fichier afin de correspondre à l'architecture attendu (nomdudossier/index.md)
5 - Ajoutez votre texte, votre contenu et mettez le en page (une image ajoutée sur un article sera placé au même endroit que le fichier index.md de l'article). Aidez-vous du bouton sur la droite pour visualiser votre travail (bien que le site rende differement les contenus, cela donne une bonne idée)
6 - Cliquez sur le bouton a droite permettant de modifier les meta-data, des propriétées de la page comme le titre, le résumé...
7 - Une fois votre travail terminé, appuyé simplement sur la disquette à droite pour sauvegarder ou appuyez sur CTRL+S. Si on vous demande un nom de commit, remplissez à l'envie mais c'est optionnel, cela permet de comprendre ce qui a été ajouté par les différents utilisateurs.
8 - Voilà


J'espère que cet article sera utile aux nouveaux utilisateurs. N'hésitez pas a ajouter des questions en dessous de ce texte pour que je puisse répondre aux plus communes
