Volver al inicio

Opensophy Hub: SSG/SPA para documentación en Markdown

Opensophy Hub — plataforma de código abierto para crear sitios web de documentación técnica basada en Markdown extendido. Navegación automática desde la estructura de archivos, tablas interactivas y UI-playgrounds simplifican la publicación de contenido. Editor CMS integrado con live-preview acelera el flujo de trabajo para desarrolladores.

Opensophy Hub: Markdown potente para documentación TI
Advertisement 728x90

Opensophy Hub: Plataforma estática SSG/SPA para documentación avanzada en Markdown

Opensophy Hub es una plataforma híbrida SSG y SPA diseñada para publicar documentación técnica, artículos y manuales. Resuelve el desafío de almacenar contenido con capacidades avanzadas de Markdown sin necesidad de MDX ni plugins adicionales. La estructura del proyecto se genera directamente desde el sistema de archivos en el directorio Docs/, donde las carpetas definen la navegación: la barra lateral, las migas de pan y las URL se crean automáticamente.

Example structure:

Docs/
├── welcome.md
├── [N][brain]Articles{article}/
│   ├── [C][folder-code]Development{development}/
│   │   └── [A][layers]Stack Selection{webrendering}.md
│   └── [C][signal]Tools{tools}/
│       └── [A][container]Dokploy Overview{dokploy}.md

Tres niveles de jerarquía —secciones ([N]), categorías ([C]), artículos ([A])— proporcionan slugs, iconos y títulos sin configuración manual de enrutamiento. Esto simplifica el mantenimiento y la escalabilidad del contenido para desarrolladores intermedios/senior.

Google AdInline article slot

Markdown avanzado sin dependencias

Hub introduce bloques enriquecidos directamente en archivos .md estándar: alertas, tarjetas, columnas, steppers, diagramas, fórmulas KaTeX y gráficos a partir de tablas. En lugar de marcado HTML con clases, utiliza construcciones sintácticas simples.

Example alert in HTML:

<div class="alert alert-warning" role="alert">
  <strong>Ostorozhno!</strong> Udalyonnye cherez <code>rm</code> files not popadayut in korzinu.
</div>

In Hub:

Google AdInline article slot
:::caution
Files deleted with `rm` don't go to the trash.
:::

Step-by-step instruction (stepper):

:::steps
:::step[status=done] Installation
`npm install`
:::
:::step[status=active] Setup
Fill out `.env`.
:::
:::step[status=pending] Launch
`npm run dev`
:::
:::

Estos bloques se renderizan de forma nativa sin bibliotecas externas, reduciendo la complejidad de la construcción y mejorando el rendimiento en modo SPA.

Tablas interactivas y playgrounds de UI

Las tablas estándar de Markdown se convierten en componentes interactivos con filtros de columna (multiselección), búsqueda con resaltado, ocultación de columnas, pantalla completa, arrastre para desplazarse y exportación a Markdown/Excel.

Google AdInline article slot

It also supports embedding live UI library components with one line:

[uic:blur-text]

Los usuarios pueden ajustar dinámicamente parámetros —escala, color, animación, velocidad— y ver los resultados en tiempo real. Perfecto para demostrar componentes en la documentación sin un playground separado.

Panel CMS para edición

El panel integrado de gestión de contenidos permite editar Markdown con vista previa en vivo. Crea páginas, categorías y secciones directamente en la interfaz —sin necesidad de reiniciar npm run dev ni ejecutar scripts—. El soporte completo para formatos de bloques ofrece un flujo de trabajo como el de un CMS completo, pero impulsado por generación estática.

Ventajas para desarrolladores:

  • Navegación automática desde la estructura de archivos.
  • Markdown avanzado sin plugins ni MDX.
  • Tablas interactivas con filtros y exportación.
  • Playgrounds en vivo para componentes UI.
  • Editor similar a CMS con vista previa.

Lo esencial

  • Estructura de archivos como navegación: Automatización completa de enrutamiento, migas de pan y barra lateral a partir de prefijos [N], [C], [A].
  • Bloques nativos de Markdown: Alertas, steppers, columnas, KaTeX, gráficos —sin dependencias—.
  • Interactividad en tablas: Filtros, búsqueda, pantalla completa, exportación a MD/Excel.
  • Playgrounds de UI: Una línea para demostraciones en vivo de componentes con parámetros.
  • Interfaz CMS: Edición con vista previa, sin necesidad de compilación.

— Editorial Team

Advertisement 728x90

Leer después