Créer un document
Dans docStatic, vous rédigez votre contenu au format Markdown dans des fichiers appelés « Topics » (sujets). En règle générale, vous créez vous-même chaque sujet, bien que certains types de documents puissent comporter des sujets générés automatiquement.
Remarque
Les documents GraphQL et OpenAPI sont générés automatiquement à partir d'un serveur ou d'un schéma.
Pour créer un sujet :
- Dans la collection Topics, cliquez sur Add File.
- Donnez un Title au sujet.
- (Facultatif) Si vous souhaitez utiliser le sujet dans l'aide contextuelle, donnez-lui un Slug. Il s'agit d'un chemin d'accès fixe à partir de
/docs/. - Donnez une Description au sujet. Celle-ci s'affiche dans la liste des fiches de documentation.
- (Facultatif) Ajoutez les balises taxonomiques requises.
- (Facultatif) Définissez les conditions.
- Assurez-vous que le statut du workflow est défini sur Brouillon.
- Saisissez votre contenu.
- Cliquez sur Enregistrer.
Avant-propos
Au début de chaque rubrique se trouve une section YAML contenue entre deux séries de trois tirets (---). docStatic l'utilise pour des éléments tels que :
- Texte conditionnel
- Taxonomies (balises de document)
- Workflows
Pour plus d'informations, consultez Créer un document dans la documentation Docusaurus.