Docusaurus: Ett utmärkt verktyg för att dokumentera projekt

En av de viktigaste uppgifterna när man skapar programvara är dokumentation, tyvärr för de av oss som utvecklar detta arbete ibland verkar det tråkigt, men det är ingen hemlighet för någon att bra dokumentation kan vara framgångsstället för något verktyg, eftersom Antingen på grund av den hjälp som ges till användare för att förstå hur applikationen fungerar korrekt eller den information som ges till andra utvecklare för att förbättra den.

Det finns ganska bra applikationer som gör att vi kan dokumentera våra projekt på ett enkelt sätt, vissa tenderar att erbjuda mer än vad vi verkligen vill ha och andra kräver komplexa installationer, en verktyg för att dokumentera projekt som uppfyller och är ganska enkelt att använda och installera är Docusaurus.

Vad är Docusaurus?

Docusaurus är ett projekt för bygga, implementera och underhålla öppen källkodsverktyg webbdokumentation, det gör det möjligt att använda språket Markdown För att skriva dokumentationen som senare kommer att publiceras som en html-webbplats, på samma sätt, låter verktyget oss utvidga och anpassa utformningen av vår dokumentationswebbplats med hjälp av React.

Generellt sett låter detta open source-verktyg som utvecklats av Facebook-programmeringsteamet oss enkelt skapa vackra och lätta webbplatser där vi korrekt kan visa dokumentationen för alla projekt.

Verktyget är utrustat med funktioner för korrekt versionering av dokument, en avancerad sökmotor, möjligheten att dokumentera och omforma vår dokumentationssida i realtid, integration med översättningar och många andra funktioner som hjälper dig att oroa dig mindre för dokumentation eller snarare för att göra dokumentationsprocessen enklare och med en trevligare finish.

Den enkla användningen av Docusaurus kan ses i följande gif som distribueras av dess utvecklare

Hur installerar jag Docusaurus?

Docusaurus huvudmål är att vara det slutgiltiga verktyget för att dokumentera applikationer med öppen källkod som finns på github, så det är väldigt enkelt att installera och köra din dokumentationswebbplats på denna plattform.

För att börja njuta av Docusaurus på Github, följ bara stegen som anges av utvecklingsteamet och som vi citerar nedan:

1. Gå till roten till din GitHub-arkivkatalog där du skapar dokumenten och kör följande kommandon:
2. yarn global add docusaurus-init or npm install --global docusaurus-init
3. docusaurus-init

Slutresultatet blir skapandet av en fil- och katalogstruktur enligt nedan: