Vous avez publié une ressource ou une application Web et avez besoin d'aide pour documenter son API . Slate est là pour vous aider à mettre votre documentation en ligne !
Documentez votre application avec Slate
Slate est une application JS qui vous permettra de créer et mettre en forme très simplement une documentation pour l'API de votre service ou d'une ressource de votre création.
Doté d'une interface très propre et responsive, Slate est une des documentations les plus agréables à l'oeil. Le fait qu'elle soit organisé sous forme d'une one page permet d'utiliser le ctrl-F si vous êtes un barbu, et une recherche en Javascript existe sur le côté gauche si ce n'est pas dans vos habitudes. De plus, la présence de deep-linking permet de garder en signet des parties précises de la documentation, un des gros manque des one-page en général.
Pour vous aider à visualiser l'application, je vous propose de faire un tour sur cette documentation exemple.
Enfin, gros point positif, Slate n'est fait que de Markdown. Pas besoin de perdre du temps en formation, vous pourrez l'utiliser directement si vous êtes un familier du langage, et après 5 minutes de formation au markdown dans le cas contraire.
Installation et utilisation
L'installation de Slate est des plus simples :
- Copier le code sur son disque.
- installer les dépendances.
- démarrer le serveur de test.
La création de votre documentation se fait ensuite très simplement avec un Markdown légèrement modifié.
Une fois fini, il ne vous reste plus qu'à mettre votre documentation en ligne. Besoin d'un hébergement gratuit ? Cette page vous expliquera comment héberger votre documentation sur Github].
Recevez nos articles par e-mail
Comme + de 11.000 personnes recevez nos articles et ressources .directement par e-mail.
