Inicio rápido
Ejecute docmd dentro de cualquier directorio que contenga archivos Markdown. Sin archivo de configuración, sobrecarga de instalación ni experiencia previa en frameworks.
1. Iniciar el servidor de desarrollo
npx @docmd/core dev
pnpm dlx @docmd/core dev
yarn dlx @docmd/core dev
bunx @docmd/core dev
Esto abre http://localhost:3000. Su documentación ahora está en vivo.
Si el puerto 3000 está actualmente en uso, docmd detecta y se vincula automáticamente al siguiente puerto disponible (por ejemplo, 3001).
2. Resolución automática de características
El motor configura todas las funciones esenciales automáticamente:
- Detección de directorio: Busca
docs/,src/docs/,documentation/,content/o cualquier archivo.mden la raíz del proyecto. - Estructuración de navegación: Construye un árbol de navegación de barra lateral anidado directamente desde la jerarquía de su directorio.
- Resolución de títulos: Extrae los títulos de las páginas de la primera etiqueta de encabezado
H1automáticamente. - Indexación de búsqueda: Genera un índice de búsqueda de texto completo en el cliente al instante.
- Caché inteligente: Activa recompilaciones en menos de 200 ms automáticamente al guardar archivos.
No se requiere docmd.config.json. Agregue uno más tarde para personalizar diseños, plugins o ajustes de control de versiones.
3. Compilar para producción
Compile sus archivos Markdown en un sitio web de producción estático y optimizado.
npx @docmd/core build
pnpm dlx @docmd/core build
yarn dlx @docmd/core build
bunx @docmd/core build
El compilador genera un sitio estático en ./site/. Aloje esta salida estática en cualquier lugar, como GitHub Pages, Vercel, Netlify o cualquier servidor HTTP estático.
¿Listo para configurar su proyecto? Aprenda cómo estructurar su repositorio en la Guía de estructura del proyecto o explore opciones de instalación local en Instalación.