Alternatives à Slate API Docs Generator

Slate API Docs Generator Description

Slate - Belle documentation statique pour votre API.

Caractéristiques

Conception simple et intuitive - Avec Slate, la description de votre API se trouve à gauche de votre documentation et tous les exemples de code à 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 - Le temps est révolu où vos utilisateurs devaient parcourir un million de pages pour trouver ce qu'ils cherchaient. Slate met toute la documentation sur une seule page. Nous n'avons toutefois pas sacrifié la capacité de liaison. Au fur et à mesure que vous faites défiler, le hachage de votre navigateur se met à jour vers l'en-tête le plus proche, ce qui vous permet de créer un lien vers un point particulier de la documentation.

Slate est juste 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 dispose de liaisons dans plusieurs langages de programmation, vous pouvez facilement insérer des onglets pour basculer entre eux. Dans votre document, vous distinguerez différentes langues en spécifiant le nom de la langue en haut de chaque bloc de code, comme avec Github Flavored Markdown.

Mise en surbrillance de la syntaxe prête à l'emploi pour près de 60 langues, aucune configuration requise.

Table des matières automatique à défilement régulier à 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 chez TripIt pour créer la documentation de notre nouvelle API, où notre table des matières contient plus de 180 entrées. Nous nous sommes assurés que la performance reste excellente, même pour des documents volumineux.

Afficher plus