Erstellen Sie mithilfe von Docsify eine Dokumentation mit Markdown-Dateien

Wenn Sie ein kostenloses Plugin, ein Framework oder ein Open-Source-Skript erstellen Sie benötigen eine Dokumentation. Es ist wichtig für dokumentieren sie ihre arbeit, sowohl für Ihre Vernunft als auch um anderen zu helfen, die Ihre großartige Ressource erlernen möchten.

Das Erstellen von Online-Dokumentation kann jedoch sehr schwierig sein. Gott sei Dank, Docsify macht es einfacher, indem Sie eine Kostenloser Dokumentationsgenerator, der auf Markdown läuft.

Das ist kein typischer statischer Standortgenerator und es tut Keine statischen HTML / CSS-Seiten erforderlich. Stattdessen es lädt Markdown-Dateien dynamisch und zeigt sie als Webseiten an. Ziemlich ordentlich!

Schauen Sie sich die Docsify-Homepage an Vorschau des Layouts, zusammen mit weitere Einrichtungsdetails.

Es erfordert, dass Sie Erstellen Sie die index.html-Datei selbst, Diese können dann auf GitHub Pages hochgeladen oder auf Ihrem eigenen Server gehostet werden. Von dort aus geht es dir nur Markdown-Dateien für jede Seite schreiben und verwenden Sie diese als Ihre primären Dokumente.

Der gesamte Prozess wird in der detailliert beschrieben Schnellstartanleitung, Das ist wahrscheinlich der beste Ort, um zu beginnen. Das kann alle laufen durch npm, Daher ist es wirklich hilfreich, die Eingabeaufforderung zu kennen oder zumindest zu lernen bereit zu sein.

Es ist möglich, eine reine HTML-Datei selbst zu erstellen und die Vorlage einfach aus dem Docsify-Installationshandbuch zu kopieren / einzufügen. Aber ich empfehle es es dynamisch machen, denn es spart eine Menge Zeit - und ist nicht wirklich der Punkt?

Wenn Sie das Docsify-System lernen, können Sie dies tun Fügen Sie Funktionen mit Markdown oder Roh-HTML hinzu. Zu diesen Funktionen gehören a Benutzerdefinierte Navigationsleiste und selbst Ihr eigenes Deckblatt mit dem Logo Ihres Projekts.

Docsify sogar kommt mit einer Reihe kostenloser Themen verpackt wenn Sie vorgefertigte Layouts verwenden möchten. Oder du kannst Durchsuchen Sie ihre Schaufenstergalerie um zu sehen, welche Projekte Docsify für ihre Dokumentation verwenden.

All die Grundlegende Setup-Informationen und Dateidownloads kann auf GitHub gefunden werden. Wenn Sie also einen Versuch machen wollen, sollten Sie dorthin gehen.

Du kannst auch Eine Live-Demo finden Sie auf der Hauptdokumentationsseite von Docsify das läuft auf Docsify. Wenn Ihnen das Webseiten-Layout gefällt, können Sie dieselbe Vorlage verwenden und in Docsify ausführen, 100% kostenlos und Open Source.