Aller au contenu principal

Comment rédiger un article pour FRVDocs ?

Ce guide explique les outils, les bases du Markdown afin de permettre à chacun d'écrire simplement et proprement ses articles avant de les envoyer sur Discord.

Nous comptons sur votre soutiens pour proposer des documents à la communauté et ainsi figurer parmis les contributeurs présents sur le site. (Chaque article rédigé aura un crédit de votre nom ainsi que le lien sur un de vos réseaux).

✨ C'est quoi le principe du format Markdown ?​

Le Markdown est un langage de mise en forme léger.
Il permet d'écrire du texte lisible même sans mise en forme tout en offrant des éléments comme des titres, listes, images, mises en gras..etc.

ℹ️ À titre informatif, vous l'avez forcément utiliser sur l'application Discord, qui utilise ce format pour ces messages

🧱 Les bases du Markdown​

1. Titres​

# Titre niveau 1
## Titre niveau 2
### Titre niveau 3

2. Texte en gras / italique​

**Texte en gras**
*Texte en italique*
~~Texte barré~~

3. Listes​

  • Liste simple :
- Élément
- Élément
  • Liste numérotée :
1. Premier
2. Deuxième

4. Bloc de citation​

> Ceci est une citation

5. Code​

  • En ligne :
`code`
  • Bloc :
<!-- -->

du code ici

6. Liens​

[Texte du lien](https://exemple.com)

7. Images​

![Texte alternatif](https://url-de-l-image)

🧰 Logiciels conseillés pour écrire en Markdown​

Les logiciels gratuits​

En ligne​

En application​

Les logiciels payants​

📤 Comment envoyer ton article pour FRVDocs ?​

Channel où poster le guide pour FRVDocs

  1. Rédige ton article.
  2. Vérifie la mise en forme.
  3. Envoie le contenu de ton .md sur Discord et ajoute ton fichier .md en pièce jointe dans le post.

Exemple de la rédaction d'un article: Exemple rédaction article

📎 Modèle simple​


---
title: Titre de mon article
description: Description de mon article
---

## Exemple du titre de mon contenu global
Développez votre sujet ici.

---

## 🙌 Contributeurs
**Rédaction:** 
- [Votre Nom Ici (Si vous le désirez)](https://monlienincroyable.com/)