Slate API Docs Generator

Slate API Docs Generator

Ardoise - belle documentation statique pour votre API.
Ardoise - belle documentation statique pour votre API.Caractéristiques Design épuré et intuitif - Avec Slate, la description de votre API se trouve à gauche de votre documentation, et tous les exemples de code sont à droite.Inspiré des documents API de Stripe et Paypal.Slate est réactif, il a donc fière allure sur les tablettes, les téléphones et même sur papier.Tout sur une seule page - Fini le temps où vos utilisateurs devaient parcourir un million de pages pour trouver ce qu'ils voulaient.Slate met toute la documentation sur une seule page.Nous n'avons cependant pas sacrifié la liaison.Au fur et à mesure que vous faites défiler, le hachage de votre navigateur se mettra à jour vers l'en-tête le plus proche, donc la liaison à un point particulier de la documentation est toujours naturelle et facile.Slate n'est que Markdown - Lorsque vous écrivez des documents avec Slate, vous écrivez simplement Markdown, ce qui facilite la modification et la compréhension.Tout est écrit dans Markdown - même les exemples de code ne sont que des blocs de code Markdown.Écrire des exemples de code dans plusieurs langues - Si votre API a des liaisons dans plusieurs langages de programmation, vous pouvez facilement mettre des onglets pour basculer entre eux.Dans votre document, vous allez distinguer différentes langues en spécifiant le nom de la langue en haut de chaque bloc de code, tout comme avec Github Flavored Markdown.Mise en évidence de la syntaxe prête à l'emploi pour près de 60 langues, aucune configuration requise.Table des matières à défilement automatique et à l'extrême gauche de la page.Lorsque vous faites défiler, il affiche votre position actuelle dans le document.C'est rapide aussi.Nous utilisons Slate at TripIt pour créer la documentation de notre nouvelle API, où notre table des matières contient plus de 180 entrées.Nous avons veillé à ce que les performances restent excellentes, même pour les documents plus volumineux.
slate-api-docs-generator

Les catégories

Alternatives à Slate API Docs Generator pour toutes les plateformes avec n'importe quelle licence

Doxygen

Doxygen

Doxygen est un outil pour générer de la documentation à partir de sources C ++ annotées, ainsi que d'autres langages de programmation populaires comme C, Objective-C, C #, PHP, Java, Python, IDL (CORBA ...
swagger.io

swagger.io

Swagger est un outil de documentation RESTapi open source.
Daux.io

Daux.io

Daux.io est un générateur de documentation qui utilise une structure de dossiers simple et des fichiers Markdown pour créer une documentation personnalisée à la volée.Il vous aide à créer une documentation attrayante d'une manière conviviale pour les développeurs.
Docsie

Docsie

Docsie est un logiciel de collaboration gratuit pour les documents logiciels, les intranets et la gestion des connaissances.Créez facilement votre documentation logicielle dans Docsie et intégrez-la dans votre site ou portail interne avec une chaîne de JavaScript.
Wikitten

Wikitten

Wikitten est un petit wiki auto-hébergé compatible avec les pages Markdown et HTML et compatible avec Git.
Sandcastle

Sandcastle

Sandcastle produit une documentation précise, de style MSDN, complète en réfléchissant sur les assemblages source et en intégrant éventuellement des commentaires de documentation XML.
Codex

Codex

Codex est une simple plate-forme de documentation Markdown basée sur des fichiers construite au-dessus de Laravel.Il est complètement personnalisable et simple à utiliser pour créer une belle documentation.
ReadMe

ReadMe

ReadMe est un espace entièrement personnalisable et collaboratif pour la documentation dynamique des API et / ou des produits.
NDoc

NDoc

NDoc génère la documentation de la bibliothèque de classes à partir des assemblys .NET et des fichiers de documentation XML générés par le compilateur C # (ou avec un outil complémentaire pour VB.NET).
DoxyS

DoxyS

DoxyS est un outil de documentation de code pour C ++ / C.DoxyS s'efforce de produire une sortie d'aspect très professionnel, présentant le code dans un ensemble structuré et facile à naviguer de pages HTML.
CppDoc

CppDoc

CppDoc génère de la documentation HTML pour les classes C ++, basée sur votre code source et les commentaires spéciaux qui y sont intégrés.
Docuie

Docuie

Docuie fournit une documentation abordable pour les développeurs uniques jusqu'aux entreprises.La documentation est extrêmement facile à configurer en quelques clics seulement.
Document! X

Document! X

Document!X est une combinaison d'un outil de documentation automatisé et d'un environnement de création complet qui peut être utilisé pour créer, publier et maintenir une documentation précise et de qualité professionnelle pour .NET, les services Web, les bases de données, les XSD, Java, Javascript.
Aglio

Aglio

aglio - Un moteur de rendu API Blueprint qui prend en charge plusieurs thèmes et génère du code HTML statique qui peut être servi par n'importe quel hôte Web.
Natural Docs

Natural Docs

Natural Docs est un générateur de documentation open-source pour plusieurs langages de programmation.Vous documentez votre code dans une syntaxe naturelle qui se lit comme un anglais simple.