Slate API Docs Generator

Slate API Docs Generator

Slate - Wunderschöne statische Dokumentation für Ihre API.Features
Slate - wunderschöne statische Dokumentation für Ihre API.Funktionen Sauberes, intuitives Design - Bei Slate befindet sich die Beschreibung Ihrer API auf der linken Seite Ihrer Dokumentation und alle Codebeispiele auf der rechten Seite.Inspiriert von den API-Dokumenten von Stripe und Paypal.Slate reagiert, sodass es auf Tablets, Handys und sogar in gedruckter Form großartig aussieht.Alles auf einer Seite - Vorbei sind die Zeiten, in denen Ihre Benutzer eine Million Seiten durchsuchen mussten, um das zu finden, was sie wollten.Slate fasst die gesamte Dokumentation auf einer einzigen Seite zusammen.Die Verlinkbarkeit wurde jedoch nicht beeinträchtigt.Während Sie blättern, wird der Hash Ihres Browsers auf die nächste Überschrift aktualisiert, so dass das Verknüpfen mit einem bestimmten Punkt in der Dokumentation immer noch natürlich und einfach ist.Slate ist nur Markdown - Wenn Sie mit Slate Dokumente schreiben, schreiben Sie nur Markdown, was das Bearbeiten und Verstehen vereinfacht.Alles ist in Markdown geschrieben - selbst die Codebeispiele sind nur Markdown-Codeblöcke.Codebeispiele in mehreren Sprachen schreiben - Wenn Ihre API über Bindungen in mehreren Programmiersprachen verfügt, können Sie einfach Registerkarten einfügen, um zwischen diesen zu wechseln.In Ihrem Dokument unterscheiden Sie verschiedene Sprachen, indem Sie den Sprachnamen oben in jedem Codeblock angeben, genau wie bei Github Flavored Markdown.Standardmäßige Syntaxhervorhebung für fast 60 Sprachen, keine Konfiguration erforderlich.Automatisches, ruckelfreies Scrollen des Inhaltsverzeichnisses ganz links auf der Seite.Während des Bildlaufs wird Ihre aktuelle Position im Dokument angezeigt.Es ist auch schnell.Wir verwenden Slate bei TripIt, um die Dokumentation für unsere neue API zu erstellen, in der unser Inhaltsverzeichnis über 180 Einträge enthält.Wir haben dafür gesorgt, dass die Leistung auch bei größeren Dokumenten hervorragend bleibt.
slate-api-docs-generator

Kategorien

Alternativen zu Slate API Docs Generator für Node.JS mit kommerzieller Lizenz