En af de vigtigste opgaver ved oprettelse af software er dokumentation, desværre for dem af os, der udvikler dette arbejde, virker det sommetider kedeligt, men det er ingen hemmelighed for nogen, at god dokumentation kan være succespunktet for ethvert værktøj, da Enten for hjælp, der gives til brugerne til at forstå den korrekte funktion af applikationen eller de oplysninger, der gives til andre udviklere for at forbedre den.
Der er ganske gode applikationer, der giver os mulighed for at dokumentere vores projekter på en enkel måde, nogle har tendens til at tilbyde mere, end vi virkelig ønsker, og andre kræver komplekse installationer, en værktøj til at dokumentere projekter der overholder og er ret enkel at bruge og installere er Docusaurus.
Hvad er Docusaurus?
Docusaurus er et projekt til opbygge, implementere og vedligeholde webdokumentation for open source-værktøjer, det gør det muligt at bruge sproget markdown For at skrive den dokumentation, der senere vil blive offentliggjort som et html-websted, på samme måde, giver værktøjet os mulighed for at udvide og tilpasse designet af vores dokumentationswebsted med brug af React.
Generelt giver dette open source-værktøj udviklet af Facebook-programmeringsteamet os mulighed for nemt at oprette smukke og lette websteder, hvor vi korrekt kan vise dokumentationen til ethvert projekt.
Værktøjet er udstyret med funktioner til korrekt versionering af dokumenter, en avanceret søgemaskine, muligheden for at dokumentere og redesigne vores dokumentationsside i realtid, integration med oversættelser og mange andre funktioner, der hjælper dig med at bekymre dig mindre om dokumentation eller rettere for at lave dokumentationsprocessen lettere og med en mere behagelig finish.
Den nemme brug af Docusaurus kan ses i følgende gif distribueret af dets udviklere
Hvordan installeres Docusaurus?
Docusaurus 'hovedformål er at være det endelige værktøj til dokumentation af open source-applikationer hostet på github, så det er virkelig nemt at installere og køre dit dokumentationswebsted på denne platform.
For at begynde at nyde Docusaurus på Github skal du bare følge de trin, der er angivet af udviklingsteamet, og som vi citerer nedenfor:
- Gå til roden til dit GitHub-arkivkatalog, hvor du opretter dokumenterne og kører følgende kommandoer:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Slutresultatet bliver oprettelsen af en fil- og bibliotekstruktur som vist nedenfor:
Interessant fejl at prøve!