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 todas las plataformas con cualquier licencia

Doxygen

Doxygen

Doxygen es una herramienta para generar documentación a partir de fuentes anotadas de C ++, así como otros lenguajes de programación populares como C, Objective-C, C #, PHP, Java, Python, IDL (CORBA ...
swagger.io

swagger.io

Swagger es una herramienta de documentación RESTapi de código abierto.
Daux.io

Daux.io

Daux.io es un generador de documentación que utiliza una estructura de carpetas simple y archivos Markdown para crear documentación personalizada sobre la marcha.Le ayuda a crear documentación de gran apariencia de una manera amigable para el desarrollador.
Docsie

Docsie

Docsie es un software de colaboración gratuito para documentos de software, intranets y gestión del conocimiento.Cree fácilmente su documentación de software en Docsie e incrústela en su sitio o portal interno con una cadena de JavaScript.
Wikitten

Wikitten

Wikitten es un pequeño wiki autohospedado que es compatible con Markdown y páginas HTML y compatible con Git.
Sandcastle

Sandcastle

Sandcastle produce una documentación precisa y completa al estilo MSDN al reflexionar sobre los ensamblajes de origen e integrar opcionalmente los comentarios de documentación XML.
Codex

Codex

Codex es una plataforma de documentación Markdown basada en archivos simple construida sobre Laravel.Es completamente personalizable y fácil de usar para crear documentación hermosa.
ReadMe

ReadMe

ReadMe es un lugar completamente personalizable y colaborativo para API dinámica y / o documentación del producto.
NDoc

NDoc

NDoc genera documentación de la biblioteca de clases a partir de ensamblados .NET y los archivos de documentación XML generados por el compilador de C # (o con una herramienta complementaria para VB.NET).
DoxyS

DoxyS

DoxyS es una herramienta de documentación de código para C ++ / C.DoxyS se esfuerza por producir una salida de aspecto muy profesional, presentando el código en un conjunto estructurado de páginas HTML fáciles de navegar.
CppDoc

CppDoc

CppDoc genera documentación HTML para clases de C ++, en función de su código fuente y comentarios especiales incrustados en él.
Docuie

Docuie

Docuie proporciona documentación asequible para desarrolladores individuales hasta clientes empresariales.La documentación es extremadamente fácil de configurar con solo unos pocos clics necesarios.
Document! X

Document! X

¡Documento!X es una combinación de una herramienta de documentación automatizada y un entorno de autoría completo que se puede utilizar para crear, publicar y mantener documentación precisa y de calidad profesional para .NET, servicios web, bases de datos, XSD, Java, Javascript.
Aglio

Aglio

aglio: un renderizador de API Blueprint que admite múltiples temas y genera HTML estático que puede ser servido por cualquier proveedor de alojamiento web.
Natural Docs

Natural Docs

Natural Docs es un generador de documentación de código abierto para múltiples lenguajes de programación.Documenta su código en una sintaxis natural que se lee como un inglés simple.