¿Qué es la aplicación Pizarras?
Slates es un proyecto gratuito de código abierto que ayuda a los desarrolladores a crear una documentación API estilista en poco tiempo.
Slate es ampliamente utilizado por decenas de empresas y grandes corporaciones de todo el mundo como NASA, SONY, Coinbase, Parrot Drones, CoinAPI, Travis-CI y Best Buy.
Slate se puede instalar desde la fuente, o usando Vagrant o Docker. Viene con una interfaz de usuario responsiva, admite resaltado de sintaxis, RTL y más.
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 por Rayas y PayPal Documentos API. Slate responde, por lo que se ve muy bien en tabletas, teléfonos e incluso en forma impresa.
- Todo en una sola página — Atrás quedaron 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 capacidad de 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 particular de la documentación sigue siendo natural y fácil.
- La pizarra es solo Markdown — Cuando escribes documentos con Slate, simplemente estás escribiendo Markdown, lo que hace que sea fácil de editar y comprender. Todo está escrito en Markdown; incluso los ejemplos de código son solo bloques de código de Markdown.
- Escribir ejemplos de código en varios idiomas — Si su API tiene enlaces en varios lenguajes de programación, puede colocar pestañas fácilmente 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 más de 100 idiomasno se requiere configuración.
- Tabla de contenidos automática y con desplazamiento fluido 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.
- Deje que sus usuarios actualicen su documentación por usted — De forma predeterminada, la documentación generada por Slate está alojada en un repositorio público de GitHub. Esto no solo significa que obtiene alojamiento gratuito para sus documentos con GitHub Pages, sino que también facilita que otros desarrolladores realicen solicitudes de extracción de sus documentos si encuentran errores tipográficos u otros problemas. Por supuesto, si no desea utilizar GitHub, también puede alojar sus documentos en otro lugar.
- Soporte RTL Diseño completo de derecha a izquierda para idiomas RTL como árabe, persa (farsi), hebreo, etc.
Recursos
Etiquetas
Herramientas de desarrollo de código abierto Programación de desarrollo Administrador de documentos autohospedado Desarrollo web sin cabeza basado en Web
