Bureau d'étude de sol dans le Val de Marne. Missions G1, G2, ANC et G5. val-de-marne@geotechnique-maison.fr → Contactez-nous

Guide complet - Créer des pages avec Markdown

Un guide complet pour créer des pages riches et bien structurées avec la syntaxe markdown. Découvrez toutes les options de formatage disponibles.

Introduction au Markdown

Ceci est un exemple de page créée à partir d'un fichier markdown. Cette page vous présente toutes les possibilités de mise en forme disponibles pour créer vos contenus.

Les titres

Vous pouvez utiliser différents niveaux de titres pour structurer votre contenu :

Titre de niveau 3

C'est un titre de troisième niveau, idéal pour les sous-sections.

Titre de niveau 4

Pour encore plus de détails dans la structure.

Mise en forme du texte

Le texte peut être formaté de plusieurs façons :

  • Texte en gras pour mettre l'accent
  • Texte en italique pour une emphase légère
  • Texte en gras et italique pour une emphase forte
  • Code inline pour des éléments techniques

Les listes

Liste à puces

Parfait pour énumérer des éléments sans ordre particulier :

  • Premier élément de la liste
  • Deuxième élément avec plus de détail
  • Troisième élément important
    • Sous-élément niveau 1
    • Sous-élément niveau 2
      • Sous-élément niveau 3
  • Retour au niveau principal

Liste numérotée

Idéale pour des étapes ou un ordre précis :

  1. Première étape du processus
  2. Deuxième étape cruciale
  3. Troisième étape de finalisation
  4. Quatrième étape de vérification
    1. Sous-étape A
    2. Sous-étape B
  5. Cinquième étape finale

Liste mixte

Vous pouvez combiner les deux types :

  1. Premier point numéroté
    • Sous-point à puces
    • Autre sous-point
  2. Deuxième point numéroté
    • Détail important
    • Autre détail

Les liens

Vous pouvez créer différents types de liens :

Les paragraphes

Les paragraphes sont séparés par une ligne vide. Ceci permet une lecture claire et aérée du contenu.

Vous pouvez écrire plusieurs phrases dans un même paragraphe. Le texte s'affichera de manière fluide et lisible grâce à la typographie Tailwind CSS qui gère automatiquement l'espacement et la taille de police.

Un nouveau paragraphe commence ici avec de nouvelles informations importantes à communiquer à vos lecteurs.

Citations

Ceci est une citation importante qui mérite d'être mise en avant dans votre contenu.

Vous pouvez également utiliser les citations pour mettre en valeur des témoignages, des conseils ou des informations clés.

Code

Pour afficher du code, utilisez trois backticks :

function exemple() {
  return "Ceci est du code";
}

Séparateurs

Vous pouvez utiliser des lignes horizontales pour séparer des sections :


Bonnes pratiques

Structure du document

  1. Utilisez toujours un seul titre H1 (le titre principal de la page)
  2. Structurez votre contenu avec des H2 pour les sections principales
  3. Utilisez H3 et H4 pour les sous-sections
  4. Aérez votre contenu avec des paragraphes courts

Mise en forme

  • N'abusez pas du gras et de l'italique
  • Utilisez les listes pour améliorer la lisibilité
  • Créez des liens pertinents et descriptifs
  • Gardez vos paragraphes concis et informatifs

Accessibilité

  1. Utilisez des textes de liens explicites
  2. Structurez logiquement votre contenu avec les niveaux de titres
  3. Évitez les blocs de texte trop longs
  4. Privilégiez des phrases courtes et claires

Conclusion

Cette fonctionnalité markdown vous permet de créer facilement des pages de contenu riches et bien structurées sans modifier le code de l'application. Il suffit de créer un fichier .md dans le dossier markdown avec les bons frontmatter et le tour est joué !

Prochaines étapes

Pour créer votre propre page :

  1. Créez un fichier .md dans le dossier /markdown
  2. Ajoutez les frontmatter requis (template, title_meta, description_meta, slug, fil_ariane)
  3. Rédigez votre contenu en markdown
  4. Accédez à votre page via /{slug}

C'est aussi simple que ça !