El archivo docmd.config.json sirve como manifiesto central de configuración para su espacio de trabajo de documentación. Gestiona la marca del sitio, las barras laterales de navegación, los parámetros de localización y las opciones del compilador del sitio estático.

Formatos del esquema de configuración

JSON es el formato de configuración primario, lo que permite una serialización de alto rendimiento entre hilos de trabajo durante compilaciones paralelas:

{
  "title": "Mi Documentación Técnica",
  "url": "https://docs.ejemplo.com",
  "src": "docs",
  "out": "site",
  "base": "/"
}

Para configuraciones dinámicas que requieren variables de entorno o lógica programática, docmd.config.ts y docmd.config.js son totalmente compatibles:

import { UserConfig } from '@docmd/api';

const config: UserConfig = {
  title: process.env.DOCS_TITLE || 'Mi Documentación Técnica',
  src: 'docs',
  out: 'site'
};

export default config;

module.exports = {
  title: process.env.DOCS_TITLE || 'Mi Documentación Técnica',
  src: 'docs',
  out: 'site'
};

Ajustes principales

Estas propiedades de nivel superior configuran las rutas base y las opciones globales del compilador:

Marca e identidad

Configure logotipos de marca y favicons de navegador en docmd.config.json:

{
  "logo": {
    "light": "assets/images/logo-dark.png",
    "dark": "assets/images/logo-light.png",
    "href": "/",
    "alt": "Logotipo de la Empresa",
    "height": "32px"
  },
  "favicon": "assets/favicon.ico"
}

Diseño y comportamiento de la interfaz

Configure encabezados, barras laterales, ubicación de búsqueda y conmutadores de tema:

{
  "layout": {
    "spa": true,
    "header": {
      "enabled": true
    },
    "sidebar": {
      "collapsible": true,
      "defaultCollapsed": false
    },
    "optionsMenu": {
      "position": "header",
      "components": {
        "search": true,
        "themeSwitch": true
      }
    }
  }
}

Consulte la guía de Diseño y zonas de la interfaz para conocer las opciones completas de personalización visual.

Opciones del compilador principal

Ajuste cómo docmd analiza y transforma su contenido Markdown:

{
  "minify": true,
  "autoTitleFromH1": true,
  "copyCode": true,
  "pageNavigation": true,
  "markdown": {
    "breaks": true
  }
}