Mintlify gestiona automáticamente muchas prácticas recomendadas de SEO, incluyendo:
  • 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 agregando el campo metatags a tu docs.json o al frontmatter de una página.

Metaetiquetas globales

Puedes configurar metaetiquetas predeterminadas agregando el campo metadata a tu docs.json.
"seo": {
    "metatags": {
        "og:image": "enlace a la imagen predeterminada para la metaetiqueta"
    }
}

Metadatos específicos de la página

Agrega tus meta tags a los metadatos de la página de esta manera:
---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
---
Las meta tags 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 compartido en redes sociales y la compatibilidad con navegadores. Puedes previsualizar cómo aparecerán tus metaetiquetas en distintas 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://tu-dominio-personalizado.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": "Worldwide",
      "category": "Technology",
      "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": "Technology",
      "article:tag": "tag1, tag2, tag3",
      "book:author": "Nombre del autor",
      "book:isbn": "1234567890",
      "book:release_date": "2024-01-01",
      "book:tag": "tag1, tag2, tag3",
      "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": "tag1, tag2, tag3",
      "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 reemplazará el archivo generado automáticamente con el mismo nombre. Si eliminas el archivo personalizado, se volverá a usar el archivo predeterminado.

Desactivar la indexación

Si quieres impedir que una página sea indexada por los motores de búsqueda, puedes incluir lo siguiente en el frontmatter de tu página:
---
noindex: true
---
También puedes establecer noindex para todas las páginas de tu documentación configurando el campo metadata.robots como "noindex" en tu docs.json:
"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

Mejores prácticas de SEO