Jedním z nejdůležitějších úkolů při vytváření softwaru je dokumentace, bohužel pro ty z nás, kteří tuto práci vyvíjejí, to někdy vypadá zdlouhavě, ale není žádným tajemstvím, že dobrá dokumentace může být bodem úspěchu jakéhokoli nástroje, protože Buď kvůli pomoci, která je poskytována uživatelům k pochopení správného fungování aplikace, nebo kvůli informacím poskytovaným jiným vývojářům, aby ji vylepšili.
Existují docela dobré aplikace, které nám umožňují dokumentovat naše projekty jednoduchým způsobem, některé mají tendenci nabízet více, než to, co opravdu chceme, a jiné vyžadují složitou instalaci, nástroj pro dokumentaci projektů který vyhovuje a jeho použití a instalace je velmi jednoduchá, je Docusaurus.
Co je Docusaurus?
Docusaurus je projekt pro vytvářejte, implementujte a udržujte webovou dokumentaci nástrojů open source nástrojů, umožňuje používat jazyk Snížení ceny Stejným způsobem, abychom mohli napsat dokumentaci, která bude později publikována jako html web, nám nástroj umožňuje rozšířit a přizpůsobit design naší webové stránky s dokumentací pomocí React.
Obecně řečeno, tento nástroj s otevřeným zdrojovým kódem vyvinutý programovacím týmem Facebooku nám umožňuje snadno vytvářet krásné a lehké webové stránky, kde můžeme správně zobrazit dokumentaci jakéhokoli projektu.
Tento nástroj je vybaven funkcemi pro správné verzování dokumentů, pokročilým vyhledávačem, možností dokumentování a redesignu našeho webového serveru s dokumenty v reálném čase, integrací s překlady a mnoha dalšími funkcemi, díky kterým si nebudete muset dělat starosti s dokumentováním, nebo spíše pro usnadnění procesu dokumentace a příjemnějšího dokončení.
Snadné použití Docusauru lze vidět na následujícím gifu distribuovaném jeho vývojáři
Jak nainstalovat Docusaurus?
Hlavním cílem Docusaurus je být definitivním nástrojem pro dokumentaci aplikací s otevřeným zdrojovým kódem hostovaných na githubu, takže je opravdu snadné nainstalovat a spustit dokumentační web na této platformě.
Chcete-li si začít užívat Docusaurus na Githubu, postupujte podle pokynů vývojového týmu a níže citujeme:
- Přejděte do kořenového adresáře úložiště GitHub, kde vytvoříte dokumenty a spustíte následující příkazy:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Konečným výsledkem bude vytvoření struktury souborů a adresářů, jak je uvedeno níže:
Zajímavá chyba k vyzkoušení!