Slate API Docs Generator

Slate API Docs Generator

Pizarra: hermosa documentación estática para su API.
Pizarra: hermosa documentación estática para su API.Características Diseño limpio e intuitivo: con Slate, la descripción de su API está en el lado izquierdo de su documentación, y todos los ejemplos de código están en el lado derecho.Inspirado en los documentos API de Stripe y Paypal.Slate es sensible, por lo que se ve muy bien en tabletas, teléfonos e incluso en forma impresa.Todo en una sola página: se acabaron los días en que los usuarios tenían que buscar en un millón de páginas para encontrar lo que buscaban.Slate pone toda la documentación en una sola página.Sin embargo, no hemos sacrificado la vinculación.A medida que se desplaza, el hash de su navegador se actualizará al encabezado más cercano, por lo que vincularse a un punto particular de la documentación sigue siendo natural y fácil.Slate es solo Markdown: cuando escribes documentos con Slate, solo estás escribiendo Markdown, lo que simplifica la edición y la comprensión.Todo está escrito en Markdown, incluso los ejemplos de código son solo bloques de código de Markdown.Escriba ejemplos de código en varios idiomas: si su API tiene enlaces en múltiples lenguajes de programación, puede poner fácilmente pestañas para cambiar entre ellos.En su documento, distinguirá diferentes idiomas especificando el nombre del idioma en la parte superior de cada bloque de código, al igual que con Github Flavored Markdown.Resaltado de sintaxis listo para usar para casi 60 idiomas, no se requiere configuración.Tabla de contenido automática de desplazamiento suave en el extremo izquierdo de la página.A medida que se desplaza, muestra su posición actual en el documento.También es rápido.Estamos utilizando Slate en TripIt para crear documentación para nuestra nueva API, donde nuestra tabla de contenido tiene más de 180 entradas.Nos hemos asegurado de que el rendimiento siga siendo excelente, incluso para documentos más grandes.
slate-api-docs-generator

Categorias

Alternativas a Slate API Docs Generator para .NET Framework con licencia gratuita