Quand on travaille sur des projets, qu'ils soient gigantesques par leur fonctionnalité ou simplement car ils sont exposés à des clients, on veut qu'ils soient documentés afin que les autres devs ou les clients s'y retrouvent sans encombres.
Bien souvent, cette documentation est éparpillée, perdue dans un confluence impossible à retrouver... ou tout simplement elle n'existe pas!
Aujourd'hui on va donc voir comment Docusaurus va nous aider simplement à gérer ça!
Qu'est-ce que Docusaurus?
Docusaurus est un outil open source qui permet la création d'une documentation à partir de fichiers Markdown.
Une fois compilé et déployé, il vous expose l'ensemble de vos fichiers markdown en une belle documentation technique sans que vous ayez eu à perdre du temps sur de nombreuses configurations. De plus, avec les outils et exemples déjà présents, il n'y a que peu de chance aussi que vous perdiez du temps sur son déploiement!
C'est con à dire comme ça, mais ça fait un sacré gain de temps sur le long terme!
Pourquoi docusaurus?
Son objectif principal est véritablement tourné vers la création simple et rapide d'une documentation technique et non d'un site statique! Ce qui est une grande différence.
D'autres outils (dont j'ai déjà pu parler par le passé) sont plus tournés vers la création d'un site statique ou d'un blog, donc les fonctionnalités, notamment vis à vis de l'organisation et de la navigation, sont complètement différents.
Par exemple, Docusaurus va proposer deux barres de navigation.
Une sur la gauche, pour permettre de naviguer dans les différents sujets et sous sujets.
Une sur la droite, pour permettre de naviguer entre les différents points et sous points de la documentation actuelle.
Autre point très utile, la recherche directement intégrée dans votre documentation! Pas besoin d'aller chercher un module externe pour cela, c'est déjà présent pour vous! Idem pour l'internationalisation et l'intégration d'un blog à côté!
Je vais m'arrêter là pour les détails des fonctionnalités car il y en a pas mal et le plus simple est d'aller les tester par vous même!
Conclusion
Pour conclure, Docusaurus est véritablement un outil qui mérite d'être testé car il a tout ce qu'il faut pour vous plaire. Simple et efficace, il pourra rapidement devenir votre allié pour faciliter la documentation de tous vos projets.
Liens
- Docusaurus : https://docusaurus.io/
J'espère que ça vous aidera! 🍺
Vous voulez me supporter?
Top comments (0)