> ## Documentation Index
> Fetch the complete documentation index at: https://tomee-mintlify-d7bc03a0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Configuración global
> Configura tu sitio de documentación Mintlify con docs.json, el archivo que controla la navegación, la apariencia y las integraciones.
El archivo `docs.json` es el archivo de configuración central de tu sitio de documentación Mintlify. Controla la configuración global de tu sitio, incluyendo la identidad visual, la estructura de navegación, las integraciones, la configuración de la API y más. Piensa en él como el plano de tu sitio.
## Campos obligatorios
Debes definir cuatro campos para construir un sitio funcional.
| Campo | Descripción |
| ---------------- | ------------------------------------------------------ |
| `name` | El nombre de tu proyecto u organización |
| `theme` | El [tema](/es/customize/themes) de diseño de tu sitio |
| `colors.primary` | El color principal de la marca como código hexadecimal |
| `navigation` | La estructura de tu contenido |
Todos los demás campos son opcionales. Agrégalos a medida que personalices y refines tu sitio.
## Configuración mínima
Para la mejor experiencia de edición, incluye la referencia `$schema` en la parte superior de tu `docs.json`. Esto habilita el autocompletado, la validación y la documentación en línea en la mayoría de los editores.
```json docs.json theme={null}
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Your project name",
"colors": {
"primary": "#ff0000"
},
"navigation": {
"groups": [
{
"group": "Home",
"pages": ["index"]
}
]
}
}
```
## Configuración
Personaliza la apariencia visual de tu sitio, incluyendo el tema, los colores, el logo, el favicon, las fuentes y el fondo.
Diseña la arquitectura de información y la experiencia de usuario de tu sitio, incluyendo la barra de navegación, el pie de página, el banner, la navegación y las redirecciones.
Controla la visualización y el comportamiento de la documentación de la API, incluyendo las especificaciones OpenAPI y AsyncAPI, el área de pruebas de la API y los ejemplos de código.
Conecta tu sitio a servicios de terceros para analytics, chat y más.
Controla cómo los motores de búsqueda indexan tu sitio, incluyendo las meta tags, la búsqueda y las marcas de tiempo de las páginas.
Referencia completa de todas las propiedades de `docs.json`.
## Dividir la configuración con `$ref`
A medida que tu configuración crece, puedes dividir `docs.json` en archivos más pequeños usando referencias `$ref`. Cada referencia apunta a un archivo JSON separado que se resuelve en tiempo de compilación.
Agrega una propiedad `$ref` con una ruta de archivo relativa en cualquier lugar de tu `docs.json`. Mintlify reemplaza el objeto `$ref` con el contenido del archivo referenciado.
```json docs.json theme={null}
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Acme Docs",
"colors": {
"primary": "#1a73e8"
},
"navigation": {
"$ref": "./config/navigation.json"
}
}
```
```json config/navigation.json theme={null}
{
"groups": [
{
"group": "Get started",
"pages": ["index", "quickstart"]
},
{
"group": "Guides",
"pages": ["guides/first-steps", "guides/advanced"]
}
]
}
```
* Los archivos referenciados pueden contener sus propias referencias `$ref`. Las rutas anidadas se resuelven de forma relativa al archivo que las contiene, no de forma relativa a `docs.json`.
* Las referencias deben apuntar a archivos JSON válidos.
* Las rutas deben ser relativas y permanecer dentro de la raíz del proyecto. La navegación de rutas (por ejemplo, `../../outside`) no está permitida.
* Las referencias circulares provocan un error de compilación.
### Fusión de claves hermanas
Si un `$ref` resuelve a un objeto, Mintlify fusiona las claves hermanas del mismo bloque sobre el contenido referenciado, permitiendo que esas claves tengan prioridad sobre las claves coincidentes en la referencia. Si un `$ref` resuelve a un valor que no es un objeto, como un array, Mintlify ignora las claves hermanas.
```json docs.json theme={null}
{
"appearance": {
"$ref": "./config/appearance.json",
"strict": true
}
}
```
## Migración desde `mint.json`
Si tu proyecto utiliza el archivo `mint.json` obsoleto, usa la [CLI](/es/cli) para migrar a `docs.json`.
Si no has instalado el [CLI](/es/cli/install), instálalo ahora:
```bash npm theme={null}
npm i -g mint
```
```bash yarn theme={null}
yarn global add mint
```
```bash pnpm theme={null}
pnpm add -g mint
```
Si ya tienes el CLI instalado, asegúrate de que esté actualizado:
```bash theme={null}
mint update
```
En tu repositorio de documentación, ejecuta:
```bash theme={null}
mint dev
```
Este comando crea un archivo `docs.json` a partir de tu `mint.json` existente. Revisa el archivo generado para asegurarte de que toda la configuración sea correcta.
Después de verificar que tu `docs.json` está configurado correctamente, puedes eliminar de forma segura tu antiguo archivo `mint.json`.