Slate (API DOCS Generator), es una excelente herramienta, muy parecida a la documentación de la API de Stripe que nos permitirá documentar todo nuestros código y pseudo-código muy fácilmente y rápidamente. Mediante Docker podemos crear rápidamente el repositorio y ponerlo en marcha en menos de 2 minutos aunque para ello, deberemos tener un simple prerequisito inicial, el siguiente:

• Docker configurado (RancherOS puede ser una excelente y rápida opción).

Para iniciar nuestro particular Slate podemos hacerlo mediante Docker Hub el cual nos permitirá, por ejemplo en RancherOS, levantar una imagen Docker a partir del repositorio siguiente y teniendo en cuenta que, por defecto, el puerto que utilizará será el: 4567.

tutum/slate

Una vez levantado el Docker, podemos corroborar su funcionamiento mediante: http://localhost:4567

Para editarlo tendremos que dirigirnos a su fichero “index.md” y seguir el formato de Markdown. Podemos ver un ejemplo de su funcionamiento en: http://lord.github.io/slate/

Autor: Joakim Vivas