Viens no vissvarīgākajiem uzdevumiem, veidojot programmatūru, ir dokumentācija, diemžēl tiem, kas izstrādā šo darbu, dažreiz tas šķiet garlaicīgs, taču nevienam nav noslēpums, ka laba dokumentācija var būt jebkura rīka veiksmes punkts, jo vai nu palīdzība, kas tiek sniegta lietotājiem, lai saprastu lietojumprogrammas pareizu darbību vai informāciju, kas tiek sniegta citiem izstrādātājiem, lai to uzlabotu.
Ir diezgan labas lietojumprogrammas, kas ļauj mums dokumentēt savus projektus vienkāršā veidā. Daži mēdz piedāvāt vairāk, nekā mēs patiešām vēlamies, bet citiem ir nepieciešamas sarežģītas instalācijas, rīks projektu dokumentēšanai kas atbilst un ir diezgan vienkārši lietojams un instalējams, ir Docusaurus.
Kas ir Docusaurus?
Dokuzaurs ir projekts vietnei veidot, ieviest un uzturēt atvērtā koda rīku tīmekļa dokumentāciju, tas ļauj lietot valodu Markdown Lai rakstītu dokumentāciju, kas vēlāk tiks publicēta kā html vietne, tādā pašā veidā rīks ļauj mums paplašināt un pielāgot mūsu dokumentācijas vietnes dizainu, izmantojot React.
Kopumā šis atvērtā pirmkoda rīks, ko izstrādājusi Facebook programmēšanas komanda, ļauj mums viegli izveidot skaistas un vieglas vietnes, kur mēs varam atbilstoši parādīt jebkura projekta dokumentāciju.
Šis rīks ir aprīkots ar funkcijām dokumentu pareizai versijai, uzlabotai meklētājprogrammai, iespējai reāllaikā dokumentēt un pārveidot mūsu dokumentācijas vietni, integrēt ar tulkojumiem un daudzām citām funkcijām, kas palīdzēs jums mazāk uztraukties par dokumentēšanu vai drīzāk par dokumenta izgatavošanu dokumentācijas process ir vienkāršāks un patīkamāks.
Docusaurus ērto lietošanu var redzēt šajā izstrādātāju izplatītajā gif
Kā instalēt Docusaurus?
Docusaurus galvenais mērķis ir kļūt par galīgo rīku, lai dokumentētu atklātā pirmkoda lietojumprogrammas, kas mitinātas github, tāpēc šajā platformā ir ļoti viegli instalēt un palaist jūsu dokumentācijas vietni.
Lai sāktu baudīt Docusaurus vietnē Github, vienkārši izpildiet izstrādes komandas norādītās darbības, kuras mēs citējam tālāk:
- Dodieties uz sava GitHub repozitorija direktorija sakni, kurā izveidosiet dokumentus un izpildīsit šādas komandas:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Gala rezultātā tiks izveidota failu un direktoriju struktūra, kā parādīts zemāk:
Interesanta kļūda, ko izmēģināt!