Introducción
docStatic es una moderna plataforma de documentación que tiende un puente entre los redactores y los desarrolladores para ayudarte a crear documentación en línea que encantará a tus usuarios.
Ofrece simultáneamente las mejores características de los sistemas de gestión de contenidos por componentes y de las soluciones de documentación como código para la documentación en línea. Con docStatic, cualquier miembro de tu equipo puede crear y editar tus documentos sin afectar al flujo de trabajo de los desarrolladores.
Características
docStatic empezó como una versión mejorada de Tinasaurus, un proyecto de código abierto basado en React que combina un generador de sitios estáticos (Docusaurus) con un sistema de gestión de contenidos sin interfaz (TinaCMS). Incluye:
- Una interfaz de edición fácil de usar para contenido en Markdown, MDX, JSON y YAML.
- Integración con flujos de trabajo existentes de Git y CI/CD.
- Componentes MDX integrados para la creación de contenido enriquecido.
- Gestor de medios compatible con proveedores de medios de terceros.
- Edición en la nube (no requiere configuración local).
- Paneles con informes sobre el estado del contenido y la salud de los enlaces.
- Servidor Model Context Protocol (MCP) para la integración de asistentes de IA.
- Chatbot de IA opcional en el navegador para responder preguntas sobre la documentación.
Fácil gestión de contenidos
Las colecciones predeterminadas de docStatic incluyen algunas de las funciones de creación de contenido más avanzadas que cabría esperar encontrar en un CCMS.
El editor de texto enriquecido facilita la adición de:
- Texto condicional, fragmentos, conjuntos de variables y URL gestionadas de forma centralizada para la reutilización de contenidos.
- Taxonomías.
- Términos de glosario.
- Bloques de código, comentarios, detalles plegables, figuras, notas al pie y pestañas. Estos están disponibles como plantillas que puedes insertar en un archivo de contenido.
El CMS utiliza un esquema GraphQL para describir la estructura de tu contenido como un conjunto de colecciones.
Paneles
docStatic añade funcionalidad de paneles a TinaCMS, consultando la API GraphQL para informar sobre el estado del contenido y la salud de los enlaces directamente en el CMS. Esto incluye un resumen de contenido que muestra el estado del flujo de trabajo de cada tema, y un panel de salud de enlaces que comprueba los enlaces externos y señala los que están rotos.
Basado en Git
El control de código fuente, la automatización y, opcionalmente, la publicación se gestionan a través de GitHub. Al editar archivos con el editor de texto enriquecido, TinaCMS realiza un commit al guardar o guarda directamente en el archivo si se trabaja de forma local. Git sigue siendo la fuente de referencia para todo el equipo.
La estructura del repositorio es muy similar a la predeterminada de Docusaurus, pero con algunos cambios necesarios para la integración con TinaCMS.
Complementos preconfigurados
docStatic viene preconfigurado con complementos que admiten funciones como ecuaciones KaTeX, búsquedas con Lunr, diagramas con Mermaid y documentación con OpenAPI. Cuenta con soporte integrado para la internacionalización (i18n). La revisión multilingüe ortográfica, gramatical y, opcionalmente, de estilo, la proporciona LanguageTool a través de complementos para el navegador y el IDE.
Integración de IA
docStatic incluye un servidor Model Context Protocol (MCP) integrado que permite a los asistentes de IA acceder directamente a tu documentación y comprenderla. Esto proporciona asistencia inteligente para la edición, la búsqueda y el análisis de contenidos basándose en la estructura y el contenido reales de tu documentación.
docStatic también puede añadir un chatbot de IA opcional a tu sitio publicado, para que los visitantes puedan hacer preguntas y obtener respuestas basadas en tu documentación. De forma predeterminada, se ejecuta por completo en el navegador del visitante —sin necesidad de un servicio externo, clave de API ni servidor—, aunque también se puede configurar para usar un proveedor de pago que alojes tú mismo.
Basado en React
El contenido se almacena en formato MDX, una extensión de Markdown que admite componentes React personalizados para funciones como las advertencias. Estos componentes están disponibles de forma universal y no es necesario declararlos en archivos individuales. Al trabajar de forma local, el servidor de desarrollo recompila las páginas al instante cuando guardas los cambios.
Totalmente documentado
Los desarrolladores encontrarán toda la información que necesitan para configurar y empezar a utilizar docStatic en la documentación de Docusaurus y TinaCMS. Esa información no se duplica aquí, para evitar que quede desactualizada. En su lugar, la documentación de docStatic se centra en el uso del CMS.