Tarkvara loomisel on üks olulisemaid ülesandeid dokumentatsioon, kahjuks tundub see meie jaoks, kes seda tööd arendame, mõnikord tüütu, kuid kellelegi pole saladus, et hea dokumentatsioon võib olla mis tahes tööriista edupunkt, sest kasutajatele antav abi rakenduse õige toimimise mõistmiseks või teave, mida selle arendamiseks teistele arendajatele pakutakse.
On üsna häid rakendusi, mis võimaldavad meil oma projekte lihtsal viisil dokumenteerida. Mõned pakuvad pigem enamat kui see, mida me tegelikult tahame, ja teised vajavad keerukaid installatsioone tööriist projektide dokumenteerimiseks mis on vastavuses ning mida on üsna lihtne kasutada ja installida, on Docusaurus.
Mis on Docusaurus?
Dokusaurus on projekti jaoks ehitada, juurutada ja hooldada avatud lähtekoodiga tööriistade veebidokumentatsiooni, see võimaldab keelt kasutada Hinnaalandus Hiljem HTML-veebisaidina avaldatava dokumentatsiooni kirjutamiseks võimaldab tööriist meil laiendada ja kohandada meie dokumentatsiooni veebisaidi kujundust React'i abil.
Üldiselt võimaldab see Facebooki programmeerimismeeskonna välja töötatud avatud lähtekoodiga tööriist meil hõlpsasti luua kauneid ja kergeid veebisaite, kus saaksime iga projekti dokumentatsiooni korralikult kuvada.
Tööriist on varustatud funktsioonidega dokumentide õigeks versioonimiseks, täpsema otsingumootori, meie dokumentatsioonisaidi reaalajas dokumenteerimise ja ümberkujundamise võimaluse, integreerimise tõlgetega ja paljude muude funktsioonidega, mis aitavad teil vähem muretseda dokumenteerimise või pigem tegemise pärast dokumenteerimisprotsess on lihtsam ja meeldivama viimistlusega.
Docusauruse lihtsat kasutamist võib näha järgmises selle arendajate levitatavas gifis
Kuidas Docusaurust installida?
Docusauruse peamine eesmärk on olla lõplik tööriist githubis hostitavate avatud lähtekoodiga rakenduste dokumenteerimiseks, seega on sellel platvormil oma dokumentatsiooniveebisaidi installimine ja käitamine väga lihtne.
Docusauruse nautimiseks Githubis järgige lihtsalt arendustiimi juhiseid ja tsiteerime allpool:
- Minge oma GitHubi hoidla kataloogi juure, kus loote dokumendid ja käivitate järgmised käsud:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Lõpptulemuseks on faili- ja kataloogistruktuuri loomine, nagu allpool näidatud:
Huvitav viga proovimiseks!