Aller au contenu principal

Introduction

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

Elle offre simultanément les meilleures caractéristiques des solutions de documentation en ligne systèmes de gestion de contenu de composants et docs-as-code. Il permet à n'importe quel membre de votre équipe de créer et d'éditer vos documents sans sacrifier le flux de travail de vos développeurs.

DocStatic a été créé comme une amélioration 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 sans tête (TinaCMS). Il comprend :

  • Une interface d'édition pour les contenus Markdown, MDX, JSON et YAML.
  • Intégration avec les flux de travail Git et CI/CD existants.
  • Composants MDX intégrés.
  • Gestionnaire de médias avec prise en charge de fournisseurs de médias tiers.
  • Édition dans le nuage (aucune installation locale n'est nécessaire).

Soutenu par Git​

Le contrôle des sources, l'automatisation et, éventuellement, la publication sont gérés par GitHub). La structure du dépôt est très similaire aux valeurs par défaut de Docusaurus, mais avec quelques changements nécessaires pour l'intégration avec TinaCMS. Lors de l'édition de fichiers avec l'éditeur de texte riche, TinaCMS s'engage lors de l'enregistrement ou enregistre directement dans le fichier si l'on travaille localement. Git reste la source de vérité pour toute l'équipe.

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 remontrances. 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.

Gestion facile du contenu​

Le CMS utilise un schéma GraphQL pour décrire la forme de votre contenu comme un ensemble de collections. Les collections par défaut de DocStatic comprennent du texte conditionnel, des termes de glossaire, des extraits, des taxonomies et des ensembles de variables. Le CMS définit des composants qui peuvent être intégrés en tant que modèles, ce qui les rend disponibles dans l'éditeur de texte enrichi. Les modèles par défaut de DocStatic comprennent les blocs de code, les commentaires, les détails repliables, les figures, les notes de bas de page et les onglets.

Plugins préconfigurés​

DocStatic est préconfiguré avec des plugins prenant en charge des fonctionnalités telles que KaTeX équations, Lunr recherche, Mermaid diagrammes et OpenAPI docs. Il existe un support intégré pour l'internationalisation (i18n). La vérification multilingue de l'orthographe, de la grammaire et, éventuellement, du style est assurée par LanguageTool au moyen de plugins pour navigateur et IDE.

Entièrement documenté​

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