Variables de Configuración y Personalizadas

Variables de Configuración y Personalizadas

Puede definir variables personalizadas directamente en docmd.config.json, cargarlas desde archivos JSON externos o módulos de JavaScript, y utilizarlas en toda su documentación.

Definición en docmd.config.json

Añada un bloque variables a su docmd.config.json:

{
  "title": "Documentación Acme Cloud",
  "variables": {
    "companyName": "Acme Technologies",
    "supportEmail": "support@acme.com",
    "cloud": {
      "apiEndpoint": "https://api.acme.cloud/v2",
      "region": "eu-west-1",
      "maxInstances": 50
    }
  }
}

Acceso en Markdown

Las propiedades anidadas se leen mediante notación de puntos:

Para contactar con soporte técnico, escriba a [\{{ supportEmail }}](mailto:\{{ supportEmail }}).

Envíe sus peticiones a nuestro punto de conexión:
```bash
curl -X GET \{{ cloud.apiEndpoint }}/status \
  -H "X-Region: \{{ cloud.region }}"

Al compilar, esto se traduce a:

```bash
curl -X GET https://api.acme.cloud/v2/status \
  -H "X-Region: eu-west-1"

Uso en Campos de Configuración

docmd ejecuta una fase unificada de registro de variables antes de renderizar plantillas, barras de navegación y pies de página.

Esto le permite utilizar variables integradas como \{{ docmd.buildYear }} o sus propios valores directamente en los campos de configuración:

{
  "title": "Acme Docs",
  "variables": {
    "companyName": "Acme Cloud Systems"
  },
  "footer": {
    "copyright": "Copyright © \{{ docmd.buildYear }} \{{ companyName }}. Todos los derechos reservados."
  },
  "layout": {
    "banners": {
      "top": {
        "content": "**¡docmd v\{{ docmd.version }} está disponible!** — Región: \{{ env.DEPLOY_REGION || 'global' }}."
      }
    }
  }
}

Archivos de Variables Externos

En proyectos grandes o con equipos distribuidos, puede apuntar "variables" a archivos externos JSON o JavaScript:

{
  "variables": "./data/variables.json"
}

{
  "auth": {
    "oauthUrl": "https://auth.acme.com/oauth2/token",
    "clientId": "acme-portal-production"
  },
  "limits": {
    "rateLimitPerMin": 1200
  }
}

{
  "variables": "./data/variables.js"
}

module.exports = {
  dynamicTimestamp: new Date().toLocaleDateString('es-ES'),
  sdkVersion: require('./package.json').version,
  activeServices: ['auth', 'billing', 'analytics']
};