16
Slate API Docs Generator
Slate - Wunderschöne statische Dokumentation für Ihre API.Features
- Kostenlose
- Self-Hosted
- Mac
- Linux
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.
Webseite:
https://github.com/tripit/slateKategorien
Alternativen zu Slate API Docs Generator für alle Plattformen mit einer Lizenz
49
21
12
Daux.io
Daux.io ist ein Dokumentationsgenerator, der mithilfe einer einfachen Ordnerstruktur und Markdown-Dateien im Handumdrehen benutzerdefinierte Dokumentationen erstellt.Auf diese Weise können Sie auf entwicklerfreundliche Weise eine ansprechende Dokumentation erstellen.
- Kostenlose
- Self-Hosted
11
8
Wikitten
Wikitten ist ein kleines selbst gehostetes Wiki, das mit Markdown- und HTML-Seiten kompatibel und Git-freundlich ist.
- Kostenlose
- Self-Hosted
5
Sandcastle
Sandcastle erstellt eine genaue, umfassende Dokumentation im MSDN-Stil, indem es über die Quellassemblys nachdenkt und optional XML-Dokumentationskommentare integriert.
- Kostenlose
- Windows
- .NET Framework
4
Codex
Codex ist eine einfache dateibasierte Markdown-Dokumentationsplattform, die auf Laravel aufbaut.Es ist vollständig anpassbar und kinderleicht zu verwenden, um eine ansprechende Dokumentation zu erstellen.
- Kostenlose
- Self-Hosted
4
4
NDoc
NDoc generiert eine Klassenbibliotheksdokumentation aus .NET-Assemblys und den vom C # -Compiler (oder mit einem Add-On-Tool für VB.NET) generierten XML-Dokumentationsdateien.
- Kostenlose
- Windows
- .NET Framework
2
1
1
Docuie
Docuie bietet kostengünstige Dokumentation für einzelne Entwickler bis hin zu Unternehmenskunden.Die Dokumentation ist mit nur wenigen Klicks sehr einfach einzurichten.
- Bezahlte
- Software as a Service (SaaS)
1
Document! X
Dokumentieren!X ist eine Kombination aus einem automatisierten Dokumentations-Tool und einer vollständigen Authoring-Umgebung, mit der genaue, professionelle Dokumentationen für .NET, Web Services, Datenbanken, XSDs, Java, Javascript erstellt, veröffentlicht und gepflegt werden können.
- Bezahlte
- Microsoft Visual Studio
- Windows
- .NET Framework
1
Aglio
aglio - Ein API-Blueprint-Renderer, der mehrere Themen unterstützt und statisches HTML ausgibt, das von jedem Webhost bereitgestellt werden kann.
- Kostenlose
- Self-Hosted