Création d'une documentation orientée utilisateur en Markdown
Pour ce projet, le but était de créer une documentation utilisateur pour JEM-Editions en utilisant l'outil MkDocs qui permets de créer facilement des documentations orientées utilisateurs en markdown.
Le Markdown est un langage comme le HTML mais avec une syntaxe simplifiée. Une fois un fichier markdown prêt à utilisation, il sera convertit en HTML. Cela permet de gagner du temps et d'avoir un code propre.
J'ai donc du installer Python ainsi que pip qui sont des dépendances au projet car MkDocs tourne grâce à Python. Ensuite il fallait, avec le contenu fournit, mettre en forme en markdown une documentation qui servirai au développement du manuel utilisateur du site jem-editions.ch. J'ai aussi du créer un repo Git de ce projet, d'abord un avec une documentation remplie avec des informations fictives, sur lequel j'ai aussi créer un readme.md ainsi que les autres fichiers essentiels.
Puis, j'ai créé une nouvelle branche sur le repo concernant JEM-Editions et dans la branche, j'ai intégré ma documentation réelle ainsi que le readme.md pour ensuite faire un merge request sur la branche master.
Quelques bases en Markdown :
- Titres :
#Titre-><h1>Titre</h1>##Titre-><h2>Titre</h2>###Titre-><h3>Titre</h3>####Titre-><h4>Titre</h4>
- Styles de texte :
_italique_-> italique**gras**-> gras
- Listes :
- Trait
- Puces
- 1.
- Liens :
[Google](https://www.google.ch)-> Google
- Images :
->