Aller au contenu principal

Fonctionnalités Markdown

docStatic utilise Markdown comme format principal de rédaction de contenu. Vous pouvez l'apprendre en dix minutes. Mais ce n'est pas obligatoire, car le CMS fournit un environnement d'édition de texte enrichi complet pour les métadonnées, le Markdown et les composants React.

Rédaction structurée simple​

Dans docStatic, les rubriques comportent trois parties :

  • Les métadonnées (au format YAML)
  • Le contenu (en Markdown)
  • Les composants React prédéfinis.

Le CMS garantit une utilisation cohérente des métadonnées et du Markdown, tandis que les composants React assurent un style uniforme et prennent en charge les fonctionnalités de réutilisation du contenu. Vous n’avez pas besoin d’ajouter vous-même de code JSX, car les composants sont déjà disponibles globalement.

Fonctionnalités standard​

Les fonctionnalités Markdown comprennent :

  • Les styles de caractères : gras, code, italique et barré.
  • Les listes à puces et numérotées.
  • Les blocs de code.
  • Les niveaux de titre (1 à 6).
  • Les lignes horizontales.
  • Les images.
  • Les liens.
  • Les citations.
  • Des tableaux simples.

Toutes ces fonctionnalités peuvent être sélectionnées directement depuis la barre d’outils de texte enrichi du CMS.

À cela, Docusaurus ajoute :

docStatic étend encore ces possibilités avec :

Front matter​

Les métadonnées de tête permettent d’ajouter des métadonnées à votre fichier Markdown. Elles sont placées tout en haut du fichier, encadrées par trois tirets ---. Les plugins de contenu peuvent avoir leur propre schéma de métadonnées de tête. docStatic utilise les métadonnées de tête pour :

  • Les conditions (pour le texte conditionnel)
  • Les descriptions
  • Les slugs (chemins fixes)
  • Balises de taxonomie
  • Titres
  • Statut du workflow

Détails​

  1. Sélectionnez Détails dans la liste Intégrer.
  2. Modifiez le composant.
  3. Donnez-lui un Résumé.
  4. Saisissez les Détails.

Exemple :​

Toggle me.

This is the detailed content.

You can use Markdown here including bold and italic text, and inline links.

Listes de fiches de documentation​

Les listes de fiches de documentation sont générées automatiquement pour les catégories de la table des matières. Cependant, vous pouvez également les ajouter manuellement à une rubrique.

  1. Sélectionnez Liste de fiches de documentation dans la liste Intégrer.
  2. Donnez-lui un Titre.

Pour plus d’informations, consultez la section Fonctionnalités Markdown dans la documentation de Docusaurus.

Exemple :​