Aller au contenu principal

Fonctionnalités Markdown

DocStatic utilise Markdown comme format principal de création 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, Markdown et les composants React.

Création structurée simple​

Les rubriques dans DocStatic comportent trois parties :

  • Métadonnées (au format YAML)
  • Contenu (en Markdown)
  • Composants React prédéfinis.

Le CMS veille à ce que les métadonnées et Markdown soient utilisés de manière cohérente, tandis que les composants React fournissent 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 :

  • Styles de caractères gras, code, italique et barré.
  • Listes à puces et numérotées.
  • Blocs de code.
  • Niveaux de titre (1 à 6).
  • Règles horizontales.
  • Images.
  • Liens.
  • Citations.
  • Tableaux simples.

Toutes ces fonctionnalités peuvent être sélectionnées directement à partir de la barre d'outils de texte enrichi dans le CMS.

À celles-ci, Docusaurus ajoute :

  • Avertissements
  • Détails (contenu extensible)
  • Listes de cartes de documentation
  • Onglets

DocStatic étend encore ces fonctionnalités avec :

  • Extraits de code (à partir de fichiers)
  • Commentaires
  • Texte conditionnel
  • Liens d'aide contextuelle
  • Diagrammes
  • Figures
  • Notes de bas de page
  • Termes du glossaire
  • Équations mathématiques
  • Extraits
  • Variables

Front matter​

Le front matter sert à ajouter des métadonnées à votre fichier Markdown. Il se trouve tout en haut du fichier, entre trois tirets ---. Les plugins de contenu peuvent avoir leur propre schéma de front matter. DocStatic utilise le front matter pour :

  • Conditions (pour le texte conditionnel)
  • Descriptions
  • Slugs (chemins fixes)
  • Balises de taxonomie
  • Titres
  • Statut du flux de travail

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.

Voici le contenu détaillé.

Vous pouvez utiliser Markdown ici, y compris le texte en gras et en italique, ainsi que les liens en ligne.

Listes de fiches documentaires​

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

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

Pour plus d'informations, consultez la section Fonctionnalités Markdown dans la documentation Docusarus.

Exemple :​