Aller au contenu principal

Introduction

DocStatic est une plateforme de documentation moderne qui comble le fossé entre les rédacteurs et les développeurs afin de vous aider à créer une documentation en ligne que vos utilisateurs adoreront.

Elle offre à la fois les meilleures fonctionnalités des systèmes de gestion de contenu par composants et des solutions docs-as-code pour la documentation en ligne. Avec DocStatic, tous les membres de votre équipe peuvent créer et modifier vos documents sans perturber le flux de travail de vos développeurs.

Fonctionnalités​

DocStatic est une version améliorée de Tinasaurus, un projet open source basé sur React qui combine un générateur de site statique (Docusaurus) avec un système de gestion de contenu headless (TinaCMS). Il comprend :

  • Une interface d'édition facile à utiliser pour les contenus Markdown, MDX, JSON et YAML.
  • Une intégration avec les workflows Git et CI/CD existants.
  • Des composants MDX intégrés.
  • Un gestionnaire de médias prenant en charge les fournisseurs de médias tiers.
  • Une édition dans le cloud (aucune configuration locale requise).

Gestion de contenu facile​

Les collections par défaut de DocStatic comprennent certaines des fonctionnalités de création les plus avancées que l'on peut attendre d'un CCMS.

L'éditeur de texte enrichi facilite l'ajout :

  • de texte conditionnel, d'extraits et d'ensembles de variables pour la réutilisation du contenu
  • de taxonomies
  • de termes de glossaire
  • de blocs de code, de commentaires, de détails repliables, de figures, de notes de bas de page et d'onglets. Ceux-ci sont disponibles sous forme de modèles que vous pouvez insérer dans un fichier de contenu.

Le CMS utilise un schéma GraphQL pour décrire la forme de votre contenu sous la forme d'un ensemble de collections.

Soutenu par Git​

Le contrôle des sources, l'automatisation et, en option, la publication sont gérés via GitHub. Lorsque vous modifiez des fichiers avec l'éditeur de texte enrichi, TinaCMS effectue une validation à l'enregistrement ou enregistre directement dans le fichier si vous travaillez localement. Git reste la source de vérité pour toute l'équipe.

La structure du référentiel est très similaire à celle par défaut de Docusaurus, mais avec quelques modifications nécessaires pour l'intégration avec TinaCMS.

Plugins préconfigurés​

DocStatic est préconfiguré avec des plugins prenant en charge des fonctionnalités telles que les équations KaTeX, la recherche Lunr, les diagrammes Mermaid et la documentation OpenAPI. La prise en charge de l'internationalisation (i18n) est intégrée. La vérification multilingue de l'orthographe, de la grammaire et, en option, du style est assurée par LanguageTool via des plugins pour navigateur et IDE.

Basé sur React​

Le contenu est stocké au format MDX, une extension de Markdown qui prend en charge les composants React personnalisés pour des fonctionnalités telles que les avertissements. Ces composants sont disponibles de manière universelle et n'ont pas besoin d'être déclarés dans des fichiers individuels. Lorsque vous travaillez en local, le serveur de développement recompile instantanément les pages lorsque vous enregistrez vos modifications.

Entièrement documenté​

Les développeurs trouveront toutes les informations dont ils ont besoin pour configurer et commencer à utiliser DocStatic dans la documentation Docusaurus et TinaCMS. Ces informations ne sont pas reproduites ici, afin d'éviter qu'elles ne deviennent obsolètes. La documentation DocStatic se concentre plutôt sur l'utilisation du CMS.