Docusaurus: Et utmerket verktøy for å dokumentere prosjekter

En av de viktigste oppgavene når du lager programvare er dokumentasjon, dessverre for de av oss som utvikler dette arbeidet, virker det noen ganger kjedelig, men det er ingen hemmelighet for noen at god dokumentasjon kan være poenget med suksess for ethvert verktøy, siden enten for hjelp som blir gitt til brukere for å forstå riktig bruk av applikasjonen eller informasjonen som blir gitt til andre utviklere for å forbedre den.

Det er ganske gode applikasjoner som lar oss dokumentere prosjektene våre på en enkel måte, noen har en tendens til å tilby mer enn det vi virkelig ønsker, og andre krever komplekse installasjoner, en verktøy for å dokumentere prosjekter som samsvarer og er ganske enkel å bruke og installere er Docusaurus.

Hva er Docusaurus?

Docusaurus er et prosjekt for bygge, implementere og vedlikeholde nettdokumentasjon med åpen kildekodeverktøy, det gjør det mulig å bruke språket Markdown For å skrive dokumentasjonen som senere vil bli publisert som et html-nettsted, på samme måte, lar verktøyet oss utvide og tilpasse utformingen av dokumentasjonsnettstedet vårt med bruk av React.

Generelt sett lar dette open source-verktøyet utviklet av Facebook-programmeringsteamet oss enkelt lage vakre og lette nettsteder der vi kan vise dokumentasjonen til ethvert prosjekt.

Verktøyet er utstyrt med funksjoner for riktig versjonering av dokumenter, en avansert søkemotor, muligheten for å dokumentere og redesigne dokumentasjonssiden vår i sanntid, integrering med oversettelser og mange andre funksjoner som vil hjelpe deg å bekymre deg mindre for dokumentasjon eller rettere for å lage dokumentasjonsprosessen enklere og med en mer behagelig finish.

Den enkle bruken av Docusaurus kan sees i følgende gif distribuert av utviklerne

Hvordan installerer jeg Docusaurus?

Docusaurus 'hovedmål er å være det definitive verktøyet for å dokumentere applikasjoner med åpen kildekode som vert på github, så det er veldig enkelt å installere og kjøre dokumentasjonsnettstedet ditt på denne plattformen.

For å begynne å nyte Docusaurus på Github, følg bare trinnene som er angitt av utviklingsteamet og som vi siterer nedenfor:

1. Gå til roten til GitHub-arkivkatalogen der du vil opprette dokumentene og kjøre følgende kommandoer:
2. yarn global add docusaurus-init or npm install --global docusaurus-init
3. docusaurus-init

Sluttresultatet blir opprettelsen av en fil- og katalogstruktur som vist nedenfor: