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 Node.JS avec licence gratuite