DocPlatform Community Edition

DocPlatform es una plataforma de documentación autoalojada que combina un editor web enriquecido con sincronización bidireccional de git, empaquetada como un único binario sin dependencias externas.

Escriba en su navegador. Haga push desde su IDE. Todo se mantiene sincronizado.

Por qué DocPlatform

Las plataformas de documentación le obligan a elegir: un editor web pulido con dependencia del proveedor, o archivos sin procesar en git sin funciones de colaboración. DocPlatform elimina esa disyuntiva.

Para quién es

DocPlatform Community Edition está diseñada para:

• Mantenedores de código abierto que guardan la documentación del proyecto en el repositorio pero desean una mejor experiencia de edición que Markdown sin procesar en GitHub
• Equipos internos de plataforma / DevEx que necesitan docs-as-code con control de acceso y un editor web, no uno u otro
• Pequeñas agencias de desarrollo que gestionan múltiples repositorios de documentación de clientes con respaldo git y sin opción autoalojada asequible
• Redactores técnicos que necesitan una experiencia de autoría pulida respaldada por control de versiones
• Desarrolladores individuales que desean una base de conocimiento personal con publicación pública, sin suscripción

No está dirigido a: empresas con requisitos estrictos de cumplimiento que necesitan SAML/SCIM (consulte la futura Enterprise Edition), ni a equipos de contenido no técnicos sin familiaridad con git.

Cómo funciona

┌──────────────────────────────────────────────────┐
│              DocPlatform (single binary)          │
│                                                  │
│   ┌────────────┐  ┌──────────┐  ┌────────────┐  │
│   │ Web Editor  │  │ SQLite   │  │ Bleve      │  │
│   │ (Next.js)   │  │ Database │  │ Search     │  │
│   └──────┬──────┘  └────┬─────┘  └──────┬─────┘  │
│          │              │               │        │
│          └──────┬───────┴───────┬───────┘        │
│                 │               │                │
│          ┌──────▼──────┐ ┌─────▼──────┐         │
│          │ Content     │ │ Git        │         │
│          │ Ledger      │ │ Engine     │         │
│          └──────┬──────┘ └─────┬──────┘         │
│                 │              │                 │
└─────────────────┼──────────────┼─────────────────┘
                  │              │
           ┌──────▼──────┐ ┌────▼──────┐
           │ Filesystem  │ │ Remote    │
           │ (.md files) │ │ Git Repo  │
           └─────────────┘ └───────────┘

Cada cambio de contenido, ya sea desde el editor web, un git push o una llamada a la API, fluye a través del Content Ledger, un único pipeline que mantiene el sistema de archivos, la base de datos y el índice de búsqueda en perfecta sincronización.

Inicio rápido

Ponga en marcha DocPlatform en menos de 5 minutos:

# Download the binary (recommended — auto-detects platform)
curl -fsSL https://valoryx.org/install.sh | sh

# Initialize a workspace
docplatform init --workspace-name "My Docs" --slug my-docs

# Start the server
docplatform serve

Abra http://localhost:3000 y registre su primer usuario; este se convierte automáticamente en Super Admin.

Para la guía completa, consulte la sección Primeros pasos.

Descripción general de funcionalidades

Plataforma principal

• Editor web enriquecido — Editor basado en Tiptap con formulario de frontmatter, alternancia a Markdown sin procesar y autoguardado
• Sincronización bidireccional de git — Web → git commit → push; CLI push → polling → actualización web
• Detección de conflictos — Concurrencia optimista basada en hash con diff descargable en caso de colisión
• Búsqueda de texto completo — Motor Bleve integrado con resultados filtrados por permisos y atajo Cmd+K
• Permisos RBAC — 5 roles: Super Admin, Admin, Editor, Commenter, Viewer
• Autenticación — Local (argon2id) + OIDC opcional de Google/GitHub
• Modelo de workspaces — Org → Workspace → Páginas con jerarquía e invitaciones de equipo
• Registro de auditoría — Cada mutación registrada con usuario, marca de tiempo y tipo de operación

Documentación publicada

• Sitio público — Sirva documentación en /p/{workspace-slug}/{page-path}
• Modo oscuro — Tema claro/oscuro automático con alternancia manual
• 7 componentes integrados — Callout, Code (200+ lenguajes), Tabs, Accordion, Cards, Steps, API Block
• Preparado para SEO — Etiquetas OpenGraph, URLs canónicas, sitemap.xml, robots.txt

Operaciones

• Diagnósticos de salud — Comando doctor de 9 puntos que verifica la consistencia FS/DB, la salud de búsqueda y los enlaces rotos
• Copias de seguridad diarias — Copias de seguridad automatizadas de SQLite con retención configurable
• Apagado graceful — Manejo limpio de señales para despliegues sin tiempo de inactividad
• Registro estructurado — Logs en formato JSON con IDs de solicitud para observabilidad

Requisitos del sistema

Próximos pasos

Rendimiento

Medido en Apple M2, SSD NVMe, workspace de 1.000 páginas:

Cómo se compara DocPlatform

Límites de Community Edition

Community Edition es el núcleo completamente funcional y autoalojado de DocPlatform. Incluye todo lo documentado en este sitio con los siguientes límites:

Estos límites cubren la mayoría de equipos pequeños y medianos. La futura Enterprise Edition ofrecerá editores ilimitados, workspaces ilimitados, SAML/SSO, soporte para PostgreSQL y búsqueda avanzada mediante Meilisearch, pero Community Edition siempre seguirá siendo la base completa y autoalojable.