Saltar al contenido principal
Mintlify gestiona automáticamente muchas de las mejores prácticas de SEO, entre ellas:
  • Generación de metaetiquetas
  • Generación del mapa del sitio (sitemap) y del archivo robots.txt
  • Estructura HTML semántica
  • Optimización para dispositivos móviles
Puedes personalizar completamente las metaetiquetas de tu sitio agregando el campo metatags a tu docs.json o al frontmatter de una página.

​
Metadatos globales

Para establecer metadatos predeterminados para todas las páginas, agrega el campo metatags a tu docs.json. 
"seo": {
    "metatags": {
        "og:image": "enlace a tu imagen de meta etiqueta por defecto"
    }
}

​
Configura una URL canónica

Si utilizas un dominio personalizado, establece la metaetiqueta canonical para asegurarte de que los motores de búsqueda indexen tu dominio preferido. Una URL canónica indica a los motores de búsqueda qué versión de tu documentación es la principal. Esto mejora el SEO (Search Engine Optimization) cuando tu documentación es accesible desde varias URL y evita problemas de contenido duplicado. 
"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}

​
Metadatos meta específicos de la página

Para definir metadatos meta específicos de la página, agréguelos al frontmatter de la página. 
---
title: "El título de tu página de ejemplo"
"og:image": "enlace a la imagen de tu etiqueta meta"
---
Las metaetiquetas con dos puntos deben estar entre comillas.

​
Referencia de etiquetas meta comunes

A continuación encontrarás una lista completa de etiquetas meta que puedes añadir a tu docs.json. Estas etiquetas ayudan a mejorar el SEO de tu sitio, el rendimiento en redes sociales y la compatibilidad con navegadores.
La etiqueta og:image añade una imagen de fondo que Mintlify superpone automáticamente con tu logotipo, el título de la página y la descripción al generar las vistas previas para redes sociales.
Puedes previsualizar cómo se mostrarán tus etiquetas meta en diferentes plataformas usando metatags.io. 
"seo": {
    "metatags": {
      "robots": "noindex",
      "charset": "UTF-8",
      "viewport": "width=device-width, initial-scale=1.0",
      "description": "Descripción de la página",
      "keywords": "palabra_clave1, palabra_clave2, palabra_clave3",
      "author": "Nombre del Autor",
      "robots": "index, follow",
      "googlebot": "index, follow",
      "google": "notranslate",
      "google-site-verification": "verification_token",
      "generator": "Mintlify",
      "theme-color": "#000000",
      "color-scheme": "light dark",
      "canonical": "https://your-custom-domain-here.com",
      "format-detection": "telephone=no",
      "referrer": "origin",
      "refresh": "30",
      "rating": "general",
      "revisit-after": "7 days",
      "language": "en",
      "copyright": "Copyright 2024",
      "reply-to": "email@example.com",
      "distribution": "global",
      "coverage": "Mundial",
      "category": "Tecnología",
      "target": "all",
      "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 de Twitter",
      "twitter:description": "Descripción de 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": "etiqueta1, etiqueta2, etiqueta3",
      "book:author": "Nombre del Autor",
      "book:isbn": "1234567890",
      "book:release_date": "2024-01-01",
      "book:tag": "etiqueta1, etiqueta2, etiqueta3",
      "profile:first_name": "John",
      "profile:last_name": "Doe",
      "profile:username": "johndoe",
      "profile:gender": "male",
      "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 Papel",
      "video:director": "Nombre del Director",
      "video:writer": "Nombre del Guionista",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "etiqueta1, etiqueta2, etiqueta3",
      "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 y archivos robots.txt personalizados

Para añadir un archivo 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 un archivo personalizado, se volverá a usar el archivo predeterminado.

​
Desactivar la indexación

Si quieres evitar 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 especificar noindex para todas las páginas de tu documentación estableciendo el campo metatags.robots en "noindex" en tu docs.json: 
"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

​
Mejores prácticas de SEO

  • Usa títulos de página claros y descriptivos (50-60 caracteres)
  • Redacta descripciones convincentes (150-160 caracteres)
  • Incluye palabras clave relevantes
  • Haz que cada título de página y cada descripción sean únicos
  • Utiliza una jerarquía de encabezados adecuada (H1 → H2 → H3)
  • Escribe para personas primero y para motores de búsqueda después
  • Incluye palabras clave relevantes en los encabezados y el contenido
  • Mantén las URL cortas, descriptivas y organizadas jerárquicamente
  • Divide el contenido extenso con subtítulos y listas
  • Enlaza a páginas relacionadas dentro de tu documentación
  • Usa texto de anclaje descriptivo en lugar de “haz clic aquí”
  • Crea clústeres de temas enlazando conceptos relacionados
  • Utiliza las funciones automáticas de referencias cruzadas
  • Usa nombres de archivo descriptivos para las imágenes
  • Incluye siempre texto alternativo por accesibilidad y SEO
  • Optimiza el tamaño de los archivos de imagen para una carga más rápida
  • Usa imágenes relevantes que respalden tu contenido