Ena najpomembnejših nalog pri ustvarjanju programske opreme je dokumentacija, žal se nam, ki razvijamo to delo, včasih zdi dolgočasno, vendar nikomur ni skrivnost, da je dobra dokumentacija lahko točka uspeha katerega koli orodja, saj bodisi za pomoč, ki je dana uporabnikom, da razumejo pravilno delovanje aplikacije ali informacije, ki jih drugim razvijalcem posredujejo za njeno izboljšanje.
Obstajajo precej dobre aplikacije, ki nam omogočajo, da svoje dokumente dokumentiramo na preprost način, nekateri ponujajo več kot tisto, kar si v resnici želimo, drugi pa zahtevajo zapletene namestitve, orodje za dokumentiranje projektov ki ustreza in je zelo preprost za uporabo in namestitev je Docusaurus.
Kaj je Docusaurus?
Docusaurus je projekt za izdelati, implementirati in vzdrževati spletno dokumentacijo o odprtokodnih orodjih, omogoča uporabo jezika Markdown Za pisanje dokumentacije, ki bo kasneje objavljena kot spletna stran html, nam orodje na enak način omogoča razširitev in prilagoditev zasnove našega spletnega mesta z dokumentacijo z uporabo React-a.
Na splošno nam to odprtokodno orodje, ki ga je razvila programska skupina Facebook, omogoča enostavno ustvarjanje lepih in lahkih spletnih mest, kjer lahko pravilno prikažemo dokumentacijo katerega koli projekta.
Orodje je opremljeno s funkcionalnostmi za pravilno različico dokumentov, naprednim iskalnikom, možnostjo dokumentiranja in preoblikovanja našega dokumentacijskega mesta v realnem času, integracijo s prevodi in številnimi drugimi funkcijami, ki vam bodo pomagale manj skrbeti za dokumentiranje oziroma za izdelavo postopek dokumentacije lažji in prijetnejši.
Enostavna uporaba Docusaurusa je razvidna iz naslednjega gifa, ki so ga razdelili njegovi razvijalci
Kako namestiti Docusaurus?
Glavni cilj Docusaurusa je biti dokončno orodje za dokumentiranje odprtokodnih aplikacij, ki gostujejo na githubu, zato je na tej platformi zelo enostavno namestiti in zagnati spletno mesto z dokumentacijo.
Če želite začeti uživati v Docusaurusu na Githubu, sledite korakom, ki jih je navedla razvojna skupina in jih citiramo spodaj:
- Pojdite v koren imenika svojega skladišča GitHub, kjer boste ustvarili dokumente in zagnali naslednje ukaze:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Končni rezultat bo ustvarjanje strukture datoteke in imenika, kot je prikazano spodaj:
Zanimiva napaka za preizkus!