Viena iš svarbiausių užduočių kuriant programinę įrangą yra dokumentacija, deja, tiems iš mūsų, kurie kuria šį darbą, kartais tai atrodo varginantis, tačiau ne paslaptis, kad gera dokumentacija gali būti bet kurio įrankio sėkmės taškas, nes Arba dėl pagalbos, kuri suteikiama vartotojams, norint suprasti teisingą programos veikimą, arba informacijos, kuri teikiama kitiems kūrėjams, norint ją tobulinti.
Yra gana gerų programų, leidžiančių dokumentuoti savo projektus paprastu būdu, kai kurie paprastai siūlo daugiau nei mes iš tikrųjų norime, o kiti reikalauja sudėtingų įrenginių, įrankis dokumentuoti projektus tai atitinka ir yra gana paprasta naudoti ir įdiegti, yra „Docusaurus“.
Kas yra Docusaurus?
Dokusauras yra projektas, skirtas kurti, diegti ir prižiūrėti atvirojo kodo įrankių žiniatinklio dokumentaciją, tai leidžia vartoti kalbą Akcijos kainos Norėdami parašyti dokumentus, kurie vėliau bus paskelbti kaip html svetainė, tokiu pačiu būdu įrankis leidžia mums išplėsti ir pritaikyti mūsų dokumentacijos svetainės dizainą naudojant „React“.
Apskritai, šis „Facebook“ programavimo komandos sukurtas atvirojo kodo įrankis leidžia mums lengvai sukurti gražių ir lengvų svetainių, kuriose galime tinkamai parodyti bet kokio projekto dokumentaciją.
Įrankyje yra funkcijų, skirtų teisingam dokumentų versijoms, išplėstinė paieškos sistema, galimybė dokumentuoti ir perprojektuoti mūsų dokumentacijos svetainę realiu laiku, integracija su vertimais ir daugybė kitų funkcijų, kurios padės mažiau jaudintis dėl dokumentavimo ar greičiau kad dokumentacijos procesas būtų lengvesnis ir malonesnis.
Paprastą „Docusaurus“ naudojimą galima pamatyti šiame kūrėjų išplatintame gife
Kaip įdiegti „Docusaurus“?
Pagrindinis „Docusaurus“ tikslas yra būti galutiniu įrankiu dokumentuoti atvirojo kodo programas, priglobtas „github“, todėl šioje platformoje tikrai lengva įdiegti ir paleisti savo dokumentacijos svetainę.
Norėdami pradėti mėgautis „Docusaurus“ sistemoje „Github“, tiesiog atlikite kūrėjo komandos nurodytus veiksmus, kuriuos cituojame toliau:
- Eikite į savo „GitHub“ saugyklos katalogo šaknį, kur sukursite dokumentus ir vykdysite šias komandas:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Galutinis rezultatas bus failo ir katalogo struktūros sukūrimas, kaip parodyta žemiau:
Įdomi klaida, kurią reikia išbandyti!