- Generación de metaetiquetas
- Generación de
sitemapy del archivorobots.txt - Estructura HTML semántica
- Optimización móvil
metatags a tu docs.json o al frontmatter de una página.
Mintlify genera las siguientes meta tags para cada página. Puedes sobrescribir estas meta tags especificándolas en tu docs.json o en el frontmatter de una página.
Metadatos básicos:
charset: utf-8- Codificación de caracteresog:type: website- Tipo de Open Graphog:site_name- Nombre de tu sitio de documentacióntwitter:card: summary_large_image- Tipo de tarjeta de Twitter
title- Título de la página, con el formato “Título de la página - Nombre del sitio”og:title- Título de Open Graph, igual que el título de la páginatwitter:title- Título de Twitter, igual que el título de la páginadescription- Descripción de la páginaog:description- Descripción de Open Graph, igual que la descripción de la páginatwitter:description- Descripción de Twitter, igual que la descripción de la página
canonical- Se genera automáticamente a partir de la URL de la páginaog:url- Se establece en la URL canónica
robots- Generado a partir de los metadatos de la páginanoindex- Generado a partir de los metadatos de la páginakeywords- Generado a partir de los metadatos de la página
og:image- Imagen de Open Graph,og:image:widthestablecido en 1200 yog:image:heighten 630twitter:image- Imagen de Twitter,twitter:image:widthestablecido en 1200 ytwitter:image:heighten 630
applicationName- Nombre de tu sitio de documentacióngenerator: Mintlify- Identifica a Mintlify como el generador del sitioapple-mobile-web-app-title- Nombre de la aplicación en la pantalla de inicio de iOSmsapplication-TileColor- Color del mosaico de Windows- Favicons e iconos de tu configuración
- Enlace de referencia al mapa del sitio (sitemap)
docs.json seo.metatags también se inyecta automáticamente en cada página, como google-site-verification para la validación en Google Search Console.
Para establecer metadatos predeterminados para todas las páginas, agrega el campo metatags a tu docs.json.
Configura una URL canónica
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.
title- Título de la páginadescription- La descripción de la página aparece debajo del título en la página y en algunos resultados de motores de búsquedakeywords- Palabras clave separadas por comasog:title- Título de Open Graph para compartir en redes socialesog:description- Descripción de Open Graphog:image- URL de la imagen de Open Graphog:url- URL de Open Graphog:type- Tipo de Open Graph como “article” o “website”og:image:width- Ancho de la imagen de Open Graphog:image:height- Altura de la imagen de Open Graphtwitter:title- Título de la tarjeta de Twittertwitter:description- Descripción de la tarjeta de Twittertwitter:image- Imagen de la tarjeta de Twittertwitter:card- Tipo de tarjeta de Twitter comosummaryosummary_large_imagetwitter:site- Cuenta del sitio en Twittertwitter:image:width- Ancho de la imagen de Twittertwitter:image:height- Altura de la imagen de Twitternoindex- Establécelo entruepara evitar que los motores de búsqueda indexen la páginarobots- Valor de la metaetiqueta robots
Las metaetiquetas con dos puntos deben ir entre comillas. Por ejemplo,
og:title: "Social media title".El campo keywords debe estar en formato de lista YAML. Por ejemplo, keywords: ["keyword1", "keyword2", "keyword3"].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.Sitemaps y archivos robots.txt
sitemap.xml y un archivo robots.txt. Puedes ver tu sitemap añadiendo /sitemap.xml a la URL de tu sitio de documentación.
Por defecto, solo se incluyen las páginas presentes en tu docs.json. Para incluir enlaces ocultos, añade seo.indexing a tu docs.json:
Sitemaps y archivos robots.txt personalizados
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 sustituye al archivo generado automáticamente con el mismo nombre. Si eliminas un archivo personalizado, el archivo predeterminado se aplicará de nuevo automáticamente.
Desactivar la indexación
noindex: true al frontmatter de la página.
noindex para todas las páginas de tu documentación estableciendo el campo metatags.robots en "noindex" en tu docs.json:
Mejores prácticas de SEO
Redacta títulos y descripciones informativas
Redacta títulos y descripciones informativas
- 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
Optimiza la estructura de tu contenido
Optimiza la estructura de tu contenido
- 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
Estrategia de enlaces internos
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 clústeres de temas enlazando conceptos relacionados
- Utiliza las funciones automáticas de referencias cruzadas
SEO de imágenes
SEO de imágenes
- 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