Jedan od najvažnijih zadataka prilikom stvaranja softvera je dokumentacija, nažalost za nas koji razvijamo ovo djelo, ponekad se čini zamorno, ali nikome nije tajna da dobra dokumentacija može biti točka uspjeha bilo kojeg alata, jer Bilo zbog pomoći koja se pruža korisnicima da razumiju ispravan rad aplikacije ili informacija koje se pružaju drugim programerima radi poboljšanja.
Postoje prilično dobre aplikacije koje nam omogućuju da svoje projekte dokumentiramo na jednostavan način, neki imaju tendenciju ponuditi više od onoga što stvarno želimo, a drugi zahtijevaju složene instalacije, alat za dokumentiranje projekata koji je u skladu i vrlo je jednostavan za upotrebu i instaliranje je Docusaurus.
Što je Docusaurus?
Dokusaurus je projekt za izgraditi, implementirati i održavati web dokumentaciju alata otvorenog koda, omogućuje upotrebu jezika Smanjenje Da bismo na isti način napisali dokumentaciju koja će kasnije biti objavljena kao html web stranica, alat nam omogućuje da proširimo i prilagodimo dizajn naše web stranice s dokumentacijom pomoću React-a.
Općenito, ovaj alat otvorenog koda koji je razvio Facebook programski tim omogućuje nam lako stvaranje lijepih i laganih web stranica na kojima možemo pravilno prikazati dokumentaciju bilo kojeg projekta.
Alat je opremljen funkcionalnostima za ispravno oblikovanje verzija dokumenata, naprednom tražilicom, mogućnošću dokumentiranja i redizajniranja stranice s dokumentacijom u stvarnom vremenu, integracijom s prijevodima i mnogim drugim značajkama koje će vam pomoći da se manje brinete oko dokumentiranja ili bolje rečeno za olakšavanje postupka dokumentacije i ugodnijeg završetka.
Lako korištenje Docusaurusa može se vidjeti na sljedećem gifu koji su distribuirali njegovi programeri
Kako instalirati Docusaurus?
Glavni cilj Docusaurusa je biti konačni alat za dokumentiranje aplikacija otvorenog koda hostiranih na githubu, tako da je zaista lako instalirati i pokrenuti vaše web mjesto s dokumentacijom na ovoj platformi.
Da biste počeli uživati u Docusaurusu na Githubu, samo slijedite korake koje je naznačio razvojni tim i koje citiramo u nastavku:
- Idite na korijen vašeg direktorija spremišta GitHub gdje ćete stvoriti dokumente i pokrenuti sljedeće naredbe:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Krajnji rezultat bit će stvaranje datoteke i strukture direktorija kako je prikazano dolje:
