Jedan od najvažnijih zadataka pri stvaranju 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ć koja se daje korisnicima da razumiju ispravan rad aplikacije ili informacije koje se pružaju drugim programerima da bi je poboljšali.
Postoje prilično dobre aplikacije koje nam omogućavaju 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 dokumentovanje projekata koji je u skladu i vrlo je jednostavan za upotrebu i instaliranje je Docusaurus.
Šta je Docusaurus?
Dokusaurus je projekat za izgraditi, implementirati i održavati web dokumentaciju alata otvorenog koda, omogućava upotrebu jezika Markdown Da bismo na isti način napisali dokumentaciju koja će kasnije biti objavljena kao html web stranica, alat nam omogućava 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 tim za programiranje omogućava nam da lako stvaramo lijepe i lagane web stranice na kojima možemo pravilno prikazati dokumentaciju bilo kojeg projekta.
Alat je opremljen funkcionalnostima za ispravno verziranje dokumenata, naprednom pretraživačem, mogućnošću dokumentiranja i redizajniranja naše dokumentacijske stranice u stvarnom vremenu, integracijom s prijevodima i mnogim drugim značajkama koje će vam pomoći da se manje brinete oko dokumentiranja, odnosno za izradu postupak dokumentacije lakši 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 github-u, tako da je zaista lako instalirati i pokrenuti vašu web lokaciju dokumentacije 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 kreirati 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:
Zanimljiva greška za isprobavanje!