Description

Slate: hermosa documentación estática para su API.

Features

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. La pizarra es receptiva, por lo que se ve muy bien en tabletas, teléfonos e incluso en la impresión.

Todo en una sola página: se acabaron los días en que sus usuarios tuvieron 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 vincular a un punto en particular en la documentación es aún natural y fácil.

Slate es solo Markdown: cuando escribes documentos con Slate, solo estás escribiendo Markdown, lo que facilita su edición y comprensión. Todo está escrito en Markdown, incluso los ejemplos de código son solo bloques de código Markdown.

Escriba ejemplos de código en varios idiomas: si su API tiene enlaces en varios lenguajes de programación, puede poner fácilmente pestañas para cambiar entre ellos. En su documento, distinguirá diferentes idiomas al especificar 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 en casi 60 idiomas, no requiere configuración.

Tabla de contenido de desplazamiento automático y sin problemas en el extremo izquierdo de la página. A medida que se desplaza, muestra su posición actual en el documento. Es rápido, también. Estamos utilizando Slate at TripIt para compilar 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.

Categorías