L'une des tâches les plus importantes lors de la création d'un logiciel est la documentation, malheureusement pour ceux d'entre nous qui développons ce travail parfois cela semble fastidieux, mais ce n'est un secret pour personne qu'une bonne documentation peut être le point de succès de n'importe quel outil, puisque soit pour le aide qui est donnée aux utilisateurs pour comprendre le bon fonctionnement de l'application ou les informations fournies aux autres développeurs pour l'améliorer.
Il existe d'assez bonnes applications qui nous permettent de documenter nos projets de manière simple, certaines ont tendance à offrir plus que ce que nous voulons vraiment et d'autres nécessitent des installations complexes, un outil pour documenter les projets qui est conforme et est assez simple à utiliser et à installer est Docusaurus.
Qu'est-ce que Docusaurus?
Docusaure est un projet pour créer, implémenter et maintenir la documentation Web des outils open source, il permet d'utiliser la langue Markdown Pour rédiger la documentation qui sera publiée ultérieurement sous forme de site Web html, de la même manière, l'outil nous permet d'étendre et de personnaliser la conception de notre site Web de documentation avec l'utilisation de React.
En général, cet outil open source développé par l'équipe de programmation de Facebook nous permet de créer facilement des sites Web beaux et légers où nous pouvons afficher correctement la documentation de n'importe quel projet.
L'outil est équipé de fonctionnalités pour le versionnage correct des documents, d'un moteur de recherche avancé, de la possibilité de documenter et de refondre notre site de documentation en temps réel, d'intégration avec des traductions et de nombreuses autres fonctionnalités qui vous aideront à moins vous soucier de la documentation ou plutôt de la réalisation le processus de documentation plus facile et avec une finition plus agréable.
L'utilisation facile de Docusaurus peut être vue dans le gif suivant distribué par ses développeurs
Comment installer Docusaurus?
L'objectif principal de Docusaurus est d'être l'outil définitif pour documenter les applications open source hébergées sur github, il est donc vraiment facile d'installer et d'exécuter votre site Web de documentation sur cette plateforme.
Pour commencer à profiter de Docusaurus sur Github, il suffit de suivre les étapes indiquées par l'équipe de développement et que nous citons ci-dessous:
- Accédez à la racine de votre répertoire de référentiel GitHub où vous allez créer les documents et exécuter les commandes suivantes:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Le résultat final sera la création d'une structure de fichiers et de répertoires comme indiqué ci-dessous:
Bug intéressant à essayer!