docsify

Ein magischer Generator für Dokumentationen.

Was ist das

docsify generiert deine Dokumentationswebseite im Hintergrund. Im Gegensatz zu GitBook werden hier keine statischen HTML Seiten generiert. Stattdessen, werden im Hintergrund Markdown Dateien geladen, umgewandelt und als Webseite dargestellt. Alles, was du brauchst, ist eine Datei namens index.html, um sie über GitHub Pages zu veröffentlichen.

Siehe Schnellstart für weitere Informationen.

Besonderheiten

• keine statisch generierten HTML Dateien
• einfach und klein (~ 19kB gzipped)
• smarte Volltextsuche als Erweiterung verfügbar
• mehrere Themes
• praktische API für (eigene) Erweiterungen
• Unterstützung für Emoji
• Kompatibel mit IE10+
• Unterstützt SSR (Beispiel)

Beispiele

Vergleiche die Liste namens Showcase mit Beispielen, wie docsify verwendet wird.

Spenden

Bitte ziehe eine Spende in Erwägung, sollte docsify dir hilfreich oder meine Arbeit dir wertvoll erscheinen. Ich freue mich, wenn du mir eine Tasse Kaffee kaufst. :heart:

Community

Andere Benutzer und das Entwickler-Team kannst du über Gitter treffen.