SEO

Mintlify gestiona automáticamente muchas de las mejores prácticas de SEO, entre ellas:

Generación de metaetiquetas
Generación del sitemap y del archivo robots.txt
Estructura HTML semántica
Optimización para dispositivos móviles

Puedes personalizar por completo las metaetiquetas de tu sitio añadiendo el campo metatags a tu docs.json o al frontmatter de una página.

Metadatos globales

Puedes configurar metadatos predeterminados añadiendo el campo metadata a tu docs.json.

"seo": {
    "metatags": {
        "og:image": "enlace a tu imagen de etiqueta meta por defecto"
    }
}

Metadatos específicos de la página

Agrega tus meta tags a los metadatos de la página de la siguiente manera:

---
title: 'Título de ejemplo de tu página'
'og:image': 'enlace a la imagen de tu etiqueta meta'
---

Las metaetiquetas con dos puntos deben escribirse entre comillas cuando las incluyas en los metadatos de la página.

Referencia de metaetiquetas comunes

A continuación encontrarás una lista completa de metaetiquetas que puedes agregar a tu docs.json. Estas metaetiquetas ayudan a mejorar el SEO de tu sitio, el alcance en redes sociales y la compatibilidad con los navegadores. Puedes previsualizar cómo se verán tus metaetiquetas en diferentes plataformas usando metatags.io.

expandible

"seo": {
    "metatags": {
      "robots": "noindex",
      "charset": "UTF-8",
      "viewport": "width=device-width, initial-scale=1.0",
      "description": "Descripción de la página",
      "keywords": "palabra clave 1, palabra clave 2, palabra clave 3",
      "author": "Nombre del autor",
      "robots": "index, follow",
      "googlebot": "index, follow",
      "google": "no-translate",
      "google-site-verification": "verification_token",
      "generator": "Mintlify",
      "theme-color": "#000000",
      "color-scheme": "light dark",
      "canonical": "https://tu-dominio-personalizado.com",
      "format-detection": "telephone=no",
      "referrer": "origen",
      "refresh": "30",
      "rating": "general",
      "revisit-after": "7 días",
      "language": "es",
      "copyright": "Copyright 2024",
      "reply-to": "correo@ejemplo.com",
      "distribution": "global",
      "coverage": "Mundial",
      "category": "Tecnología",
      "target": "todos",
      "HandheldFriendly": "true",
      "MobileOptimized": "320",
      "apple-mobile-web-app-capable": "yes",
      "apple-mobile-web-app-status-bar-style": "black",
      "apple-mobile-web-app-title": "Título de la app",
      "application-name": "Nombre de la app",
      "msapplication-TileColor": "#000000",
      "msapplication-TileImage": "path/to/tile.png",
      "msapplication-config": "path/to/browserconfig.xml",
      "og:title": "Título de Open Graph",
      "og:type": "website",
      "og:url": "https://example.com",
      "og:image": "https://example.com/image.jpg",
      "og:description": "Descripción de Open Graph",
      "og:site_name": "Nombre del sitio",
      "og:locale": "en_US",
      "og:video": "https://example.com/video.mp4",
      "og:audio": "https://example.com/audio.mp3",
      "twitter:card": "summary",
      "twitter:site": "@username",
      "twitter:creator": "@username",
      "twitter:title": "Título en Twitter",
      "twitter:description": "Descripción en Twitter",
      "twitter:image": "https://example.com/image.jpg",
      "twitter:image:alt": "Descripción de la imagen",
      "twitter:player": "https://example.com/player",
      "twitter:player:width": "480",
      "twitter:player:height": "480",
      "twitter:app:name:iphone": "Nombre de la app",
      "twitter:app:id:iphone": "12345",
      "twitter:app:url:iphone": "app://",
      "article:published_time": "2024-01-01T00:00:00+00:00",
      "article:modified_time": "2024-01-02T00:00:00+00:00",
      "article:expiration_time": "2024-12-31T00:00:00+00:00",
      "article:author": "Nombre del autor",
      "article:section": "Tecnología",
      "article:tag": "etiqueta 1, etiqueta 2, etiqueta 3",
      "book:author": "Nombre del autor",
      "book:isbn": "1234567890",
      "book:release_date": "2024-01-01",
      "book:tag": "etiqueta 1, etiqueta 2, etiqueta 3",
      "profile:first_name": "Juan",
      "profile:last_name": "Pérez",
      "profile:username": "johndoe",
      "profile:gender": "masculino",
      "music:duration": "205",
      "music:album": "Nombre del álbum",
      "music:album:disc": "1",
      "music:album:track": "1",
      "music:musician": "Nombre del artista",
      "music:song": "Nombre de la canción",
      "music:song:disc": "1",
      "music:song:track": "1",
      "video:actor": "Nombre del actor",
      "video:actor:role": "Nombre del personaje",
      "video:director": "Nombre del director",
      "video:writer": "Nombre del guionista",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "etiqueta 1, etiqueta 2, etiqueta 3",
      "video:series": "Nombre de la serie"
  }
}

Sitemaps y archivos robots.txt

Mintlify genera automáticamente un archivo sitemap.xml y un archivo robots.txt. Puedes ver tu sitemap añadiendo /sitemap.xml a la URL de tu sitio de documentación. De forma predeterminada, solo se incluyen las páginas presentes en tu docs.json. Para incluir enlaces ocultos, añade seo.indexing a tu docs.json:

"seo": {
    "indexing": all
}

Sitemaps personalizados y archivos robots.txt

Para añadir un sitemap.xml o robots.txt personalizado, crea un archivo sitemap.xml o robots.txt en la raíz de tu proyecto. Añadir un archivo personalizado sustituirá al archivo generado automáticamente con el mismo nombre. Si eliminas el archivo personalizado, se volverá a usar el archivo predeterminado.

Deshabilitar la indexación

Si deseas impedir que los motores de búsqueda indexen una página, puedes incluir lo siguiente en el frontmatter de tu página:

---
noindex: true
---

También puedes aplicar noindex a todas las páginas de tu documentación estableciendo el campo metadata.robots en "noindex" dentro de tu docs.json:

"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

Mejores prácticas de SEO

Escribe títulos y descripciones claros

Usa títulos de página claros y descriptivos (50-60 caracteres)
Escribe descripciones convincentes (150-160 caracteres)
Incluye palabras clave relevantes
Haz que el título y la descripción de cada página sean únicos

Optimiza la estructura de tu contenido

Usa una jerarquía adecuada de encabezados (H1 → H2 → H3)
Escribe primero para personas y luego para motores de búsqueda
Incluye palabras clave relevantes en encabezados y contenido
Mantén las URL cortas, descriptivas y organizadas de forma jerárquica
Divide el contenido extenso con subtítulos y listas

Estrategia de enlaces internos

Enlaza a páginas relacionadas dentro de tu documentación
Usa texto de anclaje descriptivo en lugar de “haz clic aquí”
Crea grupos temáticos enlazando conceptos relacionados
Usa las funciones automáticas de referencias cruzadas

SEO para imágenes

Usa nombres de archivo descriptivos para las imágenes
Incluye siempre texto alternativo para accesibilidad y SEO
Optimiza el tamaño de las imágenes para una carga más rápida
Usa imágenes relevantes que refuercen tu contenido

Primeros pasos

Configuración principal

Optimización de IA

Componentes

Páginas de API

Autenticación y personalización

Guías

Integraciones

Control de versiones y CI/CD

Metadatos globales

Metadatos específicos de la página

Referencia de metaetiquetas comunes

Sitemaps y archivos robots.txt

Sitemaps personalizados y archivos robots.txt

Deshabilitar la indexación

Mejores prácticas de SEO

​Metadatos globales

​Metadatos específicos de la página

​Referencia de metaetiquetas comunes

​Sitemaps y archivos robots.txt

​Sitemaps personalizados y archivos robots.txt

​Deshabilitar la indexación

​Mejores prácticas de SEO

Metadatos globales

Metadatos específicos de la página

Referencia de metaetiquetas comunes

Sitemaps y archivos robots.txt

Sitemaps personalizados y archivos robots.txt

Deshabilitar la indexación

Mejores prácticas de SEO