Aller au contenu principal

Introduction

docStatic est une plateforme de documentation moderne qui fait le lien entre les rédacteurs et les développeurs pour vous aider à créer une documentation en ligne que vos utilisateurs adoreront.

Elle combine les meilleurs atouts des solutions systèmes de gestion de contenu par composants et docs-as-code pour la documentation en ligne. Avec docStatic, n'importe quel membre de votre équipe peut créer et modifier vos documents sans perturber le flux de travail de vos développeurs.

Fonctionnalités​

docStatic est né d’une amélioration de Tinasaurus, un projet open source basé sur React qui combine un static site generator (Docusaurus) et un headless content management system (TinaCMS). Il comprend :

  • Une interface d’édition conviviale pour les contenus Markdown, MDX, JSON et YAML.
  • L’intégration aux workflows Git et CI/CD existants.
  • Des composants MDX intégrés pour la création de contenu enrichi.
  • Un gestionnaire de médias prenant en charge les fournisseurs de médias tiers.
  • L’édition dans le cloud (aucune installation locale requise).
  • Des tableaux de bord fournissant des rapports sur l’état du contenu et la validité des liens.
  • Un serveur MCP (Model Context Protocol) pour l’intégration d’un assistant IA.
  • Un chatbot IA intégrés au navigateur (en option) pour répondre aux questions relatives à la documentation.

Gestion de contenu simplifiée​

Les collections par défaut de docStatic intègrent certaines des fonctionnalités de rédaction les plus avancées que l’on peut attendre d’un CCMS.

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

  • Du texte conditionnel, des extraits, des ensembles de variables et des URL gérées de manière centralisée pour la réutilisation du contenu.
  • Des taxonomies.
  • Des termes de glossaire.
  • Des blocs de code, des commentaires, des détails repliables, des figures, des notes de bas de page et des 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 structure de votre contenu sous la forme d’un ensemble de collections.

Tableaux de bord​

docStatic ajoute des fonctionnalités de tableau de bord à TinaCMS, en interrogeant l’API GraphQL pour fournir des rapports sur l’état du contenu et la validité des liens directement dans le CMS. Cela inclut un aperçu du contenu affichant l’état du workflow de chaque rubrique, ainsi qu’un tableau de bord de santé des liens qui vérifie les liens externes et signale ceux qui sont rompus.

Prise en charge de Git​

Le contrôle de version, l’automatisation et, en option, la publication sont gérés via GitHub. Lors de la modification de fichiers avec l’éditeur de texte enrichi, TinaCMS effectue un commit à l’enregistrement ou enregistre directement dans le fichier si le travail s’effectue en local. Git reste la source de référence pour toute l’équipe.

La structure du dépôt est très similaire aux paramètres par défaut de Docusaurus, mais comporte quelques modifications nécessaires à 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. L’internationalisation (i18n) est prise en charge de manière native. 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.

Intégration de l’IA​

docStatic inclut un serveur MCP (Model Context Protocol) intégré qui permet aux assistants IA d’accéder directement à votre documentation et de la comprendre. Cela offre une assistance intelligente pour l’édition, la recherche et l’analyse de contenu en fonction de la structure et du contenu réels de votre documentation.

docStatic peut également ajouter un chatbot IA optionnel à votre site publié, afin que les visiteurs puissent poser des questions et obtenir des réponses fondées sur votre documentation. Par défaut, il s’exécute entièrement dans le navigateur du visiteur — aucun service externe, aucune clé API ni aucun serveur n’est requis — bien qu’il puisse également être redirigé vers un fournisseur payant que vous hébergez vous-même.

Basé sur React​

Le contenu est stocké au format MDX — une extension de Markdown qui prend en charge des 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 nécessaires pour configurer et commencer à utiliser docStatic dans la documentation de Docusaurus et de TinaCMS. Ces informations ne sont pas reprises ici, afin d’éviter qu’elles ne deviennent obsolètes. La documentation de docStatic se concentre plutôt sur l’utilisation du CMS.