Jednym z najważniejszych zadań przy tworzeniu oprogramowania jest dokumentacja, niestety dla tych z nas, którzy opracowują tę pracę, czasami wydaje się to żmudne, ale nie jest tajemnicą, że dobra dokumentacja może być punktem sukcesu każdego narzędzia, ponieważ albo za pomoc, że jest przekazywana użytkownikom w celu zrozumienia prawidłowego działania aplikacji lub informacji dostarczanych innym programistom w celu jej ulepszenia.
Istnieją całkiem dobre aplikacje, które pozwalają nam dokumentować nasze projekty w prosty sposób, niektóre oferują zwykle więcej, niż naprawdę chcemy, a inne wymagają skomplikowanych instalacji, narzędzie do dokumentowania projektów który jest zgodny i jest dość prosty w obsłudze i instalacji to Docusaurus.
Co to jest Docusaurus?
Dokuzaur to projekt dla tworzyć, wdrażać i utrzymywać dokumentację internetową narzędzi typu open source, pozwala na używanie języka Obniżka cen Aby napisać dokumentację, która później zostanie opublikowana jako strona html, w ten sam sposób narzędzie pozwala nam na rozszerzenie i dostosowanie wyglądu naszej strony z dokumentacją za pomocą Reacta.
Ogólnie rzecz biorąc, to narzędzie open source opracowane przez zespół programistów Facebooka pozwala nam łatwo tworzyć piękne i lekkie strony internetowe, na których możemy odpowiednio wyświetlić dokumentację dowolnego projektu.
Narzędzie wyposażone jest w funkcjonalności do poprawnej wersjonowania dokumentów, zaawansowaną wyszukiwarkę, możliwość dokumentowania i przeprojektowywania naszej strony dokumentacyjnej w czasie rzeczywistym, integrację z tłumaczeniami i wiele innych funkcji, które pomogą Ci mniej martwić się o dokumentowanie, a raczej o wykonanie proces dokumentacji jest łatwiejszy i przyjemniejszy.
Łatwość użycia Docusaurusa można zobaczyć na poniższym gifie rozpowszechnianym przez jego twórców
Jak zainstalować Docusaurusa?
Głównym celem Docusaurus jest bycie ostatecznym narzędziem do dokumentowania aplikacji open source hostowanych na github, więc instalacja i uruchamianie witryny z dokumentacją na tej platformie jest naprawdę łatwe.
Aby zacząć cieszyć się Docusaurusem na Githubie, po prostu wykonaj kroki wskazane przez zespół programistów, które zacytujemy poniżej:
- Przejdź do katalogu głównego repozytorium GitHub, w którym utworzysz dokumenty i uruchom następujące polecenia:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Efektem końcowym będzie utworzenie struktury plików i katalogów, jak pokazano poniżej:
Ciekawy błąd do wypróbowania!