Introduction
DocStatic es una moderna plataforma de documentación que tiende un puente entre escritores y 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 las soluciones docs-as-code para documentación en línea. Con docStatic, cualquier miembro de su equipo puede crear y editar sus documentos sin sacrificar el flujo de trabajo de los desarrolladores.
Características
DocStatic es una mejora 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 Markdown, MDX, JSON y YAML.
- Integración con flujos de trabajo Git y CI/CD existentes.
- Componentes MDX integrados.
- Administrador de medios con soporte para proveedores de medios externos.
- Edición en la nube (no requiere configuración local).
Fácil gestión de contenidos
Las colecciones predeterminadas de docStatic incluyen algunas de las funciones de creación más avanzadas que cabría esperar encontrar en un CCMS.
El editor de texto enriquecido facilita la adición de:
- Texto condicional, fragmentos y conjuntos de variables para la reutilización de contenidos.
- Taxonomías.
- Términos del glosario.
- Bloques de código, comentarios, detalles plegables, figuras, notas al pie y pestañas. Estos están disponibles como plantillas que se pueden insertar en un archivo de contenido.
El CMS utiliza un esquema GraphQL para describir la forma de su contenido como un conjunto de colecciones.
Respaldado por 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 una confirmación al guardar o guarda directamente en el archivo si se trabaja localmente. Git sigue siendo la fuente de verdad 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úsqueda Lunr, diagramas Mermaid y documentos OpenAPI. Hay soporte integrado para la internacionalización (i18n). La ortografía multilingüe, la gramática y, opcionalmente, la revisión de estilo son proporcionadas por LanguageTool a través de complementos para el navegador y el IDE.
Basado en React
El contenido se almacena en formato MDX, una extensión de Markdown que admite componentes React personalizados para funciones como advertencias. Estos componentes están disponibles de forma universal y no es necesario declararlos en archivos individuales. Cuando se trabaja de forma local, el servidor de desarrollo recompila instantáneamente las páginas al guardar 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 la posibilidad de que quede desactualizada. En su lugar, la documentación de docStatic se centra en el uso del CMS.