Eine der wichtigsten Aufgaben beim Erstellen von Software ist die Dokumentation. Leider scheint es für diejenigen von uns, die diese Arbeit entwickeln, manchmal mühsam, aber es ist kein Geheimnis, dass eine gute Dokumentation der Erfolgspunkt eines jeden Tools sein kann, da entweder für die Hilfe das wird Benutzern gegeben, um den korrekten Betrieb der Anwendung oder die Informationen zu verstehen, die anderen Entwicklern zur Verbesserung zur Verfügung gestellt werden.
Es gibt recht gute Anwendungen, mit denen wir unsere Projekte auf einfache Weise dokumentieren können. Einige bieten mehr als das, was wir wirklich wollen, und andere erfordern komplexe Installationen Tool zum Dokumentieren von Projekten das entspricht und ist recht einfach zu bedienen und zu installieren ist Docusaurus.
Was ist Docusaurus?
Dokusaurus ist ein Projekt für Erstellen, Implementieren und Verwalten der Webdokumentation zu Open Source-Toolsermöglicht es, die Sprache zu verwenden Markdown Um die Dokumentation zu schreiben, die später als HTML-Website veröffentlicht wird, können wir mit dem Tool das Design unserer Dokumentationswebsite mithilfe von React erweitern und anpassen.
Im Allgemeinen können wir mit diesem vom Facebook-Programmierteam entwickelten Open-Source-Tool auf einfache Weise schöne und leichte Websites erstellen, auf denen wir die Dokumentation jedes Projekts ordnungsgemäß anzeigen können.
Das Tool verfügt über Funktionen für die korrekte Versionierung von Dokumenten, eine erweiterte Suchmaschine, die Möglichkeit, unsere Dokumentationssite in Echtzeit zu dokumentieren und neu zu gestalten, die Integration in Übersetzungen und viele andere Funktionen, mit denen Sie sich weniger Gedanken über die Dokumentation oder vielmehr über das Erstellen machen müssen Der Dokumentationsprozess ist einfacher und angenehmer.
Die einfache Verwendung von Docusaurus ist im folgenden GIF zu sehen, das von den Entwicklern verteilt wird
Wie installiere ich Docusaurus?
Das Hauptziel von Docusaurus ist es, das endgültige Tool für die Dokumentation von Open Source-Anwendungen zu sein, die auf Github gehostet werden. Daher ist es wirklich einfach, Ihre Dokumentationswebsite auf dieser Plattform zu installieren und auszuführen.
Um Docusaurus auf Github zu genießen, befolgen Sie einfach die vom Entwicklungsteam angegebenen Schritte, die wir unten zitieren:
- Wechseln Sie zum Stammverzeichnis Ihres GitHub-Repository-Verzeichnisses, in dem Sie die Dokumente erstellen und die folgenden Befehle ausführen:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Das Endergebnis ist die Erstellung einer Datei- und Verzeichnisstruktur wie unten gezeigt:
Interessanter Fehler zum Ausprobieren!