Jednou z najdôležitejších úloh pri vytváraní softvéru je dokumentácia, bohužiaľ pre tých z nás, ktorí túto prácu vyvíjajú, sa to niekedy zdá zdĺhavé, ale nie je nikým tajomstvom, že dobrá dokumentácia môže byť bodom úspechu každého nástroja, pretože Buď kvôli pomoc poskytovaná používateľom pri porozumení správneho fungovania aplikácie alebo informácie poskytované iným vývojárom na jej vylepšenie.
Existujú celkom dobré aplikácie, ktoré nám umožňujú dokumentovať naše projekty jednoduchým spôsobom, niektoré majú tendenciu ponúkať viac, ako skutočne chceme, a iné vyžadujú zložitú inštaláciu, nástroj na dokumentovanie projektov ktorý je v súlade a je veľmi jednoduchý na používanie a inštaláciu, je Docusaurus.
Čo je Docusaurus?
Docusaurus je projekt pre vytváranie, implementácia a údržba webovej dokumentácie k nástrojom otvoreného zdroja, umožňuje použitie jazyka Markdown Rovnakým spôsobom, aby sme mohli napísať dokumentáciu, ktorá bude neskôr zverejnená ako webová stránka vo formáte html, nám nástroj umožňuje rozšíriť a prispôsobiť dizajn našej webovej stránky s dokumentáciou pomocou nástroja React.
Všeobecne povedané, tento nástroj s otvoreným zdrojom vyvinutý programovacím tímom Facebooku nám umožňuje ľahko vytvárať nádherné a ľahké webové stránky, na ktorých dokážeme správne zobraziť dokumentáciu ľubovoľného projektu.
Nástroj je vybavený funkciami pre správne vytváranie verzií dokumentov, pokročilým vyhľadávacím nástrojom, možnosťou dokumentovania a redizajnu našej dokumentačnej stránky v reálnom čase, integráciou s prekladmi a mnohými ďalšími funkciami, vďaka ktorým si nebudete musieť robiť starosti s dokumentovaním alebo skôr s vytváraním proces dokumentácie ľahší a s príjemnejším povrchom.
Ľahké použitie Docusauru je zrejmé z nasledujúceho gifu distribuovaného jeho vývojármi
Ako nainštalovať Docusaurus?
Hlavným cieľom Docusaurus je byť definitívnym nástrojom na dokumentáciu aplikácií s otvoreným zdrojovým kódom hostovaných na serveri github, takže inštalácia a spustenie dokumentačného webu na tejto platforme je naozaj ľahké.
Ak si chcete začať užívať Docusaurus na stránkach Github, postupujte podľa krokov vývojového tímu, ktoré citujeme nižšie:
- Prejdite do koreňového adresára svojho úložiska GitHub, kde vytvoríte dokumenty a spustíte nasledujúce príkazy:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Konečným výsledkom bude vytvorenie štruktúry súborov a adresárov, ako je uvedené nižšie:
Zaujímavá chyba, ktorú treba vyskúšať!