Elija el método de instalación que se adapte a su flujo de trabajo. Se requiere Node.js 20 o superior para compilaciones locales.
1. Instalación local (Recomendada)
Ejecutar docmd localmente mantiene la configuración de su documentación versionada directamente con su código fuente.
# Instalar como dependencia de desarrollo
npm install -D @docmd/core
# Inicializar un nuevo proyecto
npx docmd init
# Instalar como dependencia de desarrollo
pnpm add -D @docmd/core
# Inicializar un nuevo proyecto
pnpm dlx docmd init
# Instalar como dependencia de desarrollo
yarn add -D @docmd/core
# Inicializar un nuevo proyecto
yarn dlx docmd init
# Instalar como dependencia de desarrollo
bun add -D @docmd/core
# Inicializar un nuevo proyecto
bunx docmd init
# Descargar la imagen oficial multiarquitectura
docker pull ghcr.io/docmd-io/docmd:latest
# Compilar documentación desde docs/ local a site/
docker run -v $(pwd)/docs:/docs -v $(pwd)/site:/site ghcr.io/docmd-io/docmd:latest build
Consulte la Guía de despliegue con Docker para configuraciones de Docker Compose y Kubernetes.
Una vez instalado localmente, puede usar npx docmd dev para iniciar el servidor de vista previa en vivo, o agregar scripts de compilación directamente a su package.json.
2. Instalación global
Instale el paquete globalmente para crear o ver sitios de forma previa en cualquier lugar de su sistema sin crear un proyecto local.
npm install -g @docmd/core
pnpm add -g @docmd/core
yarn global add @docmd/core
bun add -g @docmd/core
Una vez instalado, el binario docmd está disponible globalmente:
docmd dev # Iniciar un servidor de desarrollo local
docmd build # Compilar salida de sitio estático
3. Integración solo para navegador
Incruste el motor de renderizado directamente dentro de una aplicación web existente a través de CDN.
Esto omite la CLI y carga el motor de análisis directamente en el navegador. Úselo para portales dinámicos y renderizado interactivo en el cliente en lugar de sitios web estáticos para SEO.
Agregue la hoja de estilos y el motor JavaScript a su encabezado HTML.
<!-- Hoja de estilos principal -->
<link rel="stylesheet" href="https://unpkg.com/@docmd/ui/assets/css/docmd-main.css">
<!-- Motor de renderizado isomórfico -->
<script src="https://unpkg.com/@docmd/live/public/docmd-live.js"></script>
Consulte la Guía de API de navegador para obtener detalles completos de integración.
4. Solución de problemas
Permiso denegado (Errores EACCES)
No use sudo para instalaciones globales en macOS o Linux. Solucione los conflictos de permisos utilizando un administrador de versiones de Node.js como nvm o fnm.
Políticas de ejecución de PowerShell (Windows)
Si Windows bloquea la ejecución de comandos, abra PowerShell como administrador y habilite la ejecución de scripts para el usuario actual.
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser