A plataforma gera automaticamente a maioria das meta tags.

No entanto, você pode personalizá-las completamente adicionando o campo metadata ao seu docs.json ou ao frontmatter da página.

​
Meta tags globais

Você pode definir meta tags padrão adicionando o campo metadata ao seu docs.json.

"seo": {
    "metatags": {
        "og:image": "link to your default meta tag image"
    }
}

​
Meta tags específicas da página

Adicione suas meta tags aos metadados da página desta forma:

---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
---

Meta tags com dois pontos precisam ser digitadas entre aspas quando você as coloca nos metadados da página.

​
Sitemaps

O Mintlify gera automaticamente um arquivo sitemap.xml e um arquivo robots.txt. Simplesmente navegue para /sitemap.xml para ver seu sitemap.

Apenas as páginas incluídas no seu docs.json são incluídas por padrão. Para incluir links ocultos, adicione seo.indexing ao seu docs.json:

"seo": {
    "indexing": all
}

​
Desativando a indexação

Se você quiser impedir que uma página seja indexada pelos mecanismos de busca, você pode incluir o seguinte no frontmatter da sua página:

---
noindex: true
---

Você também pode especificar noindex para todas as páginas em sua documentação definindo o campo metadata.robots como "noindex" no seu docs.json:

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

​
Referência de Meta Tags Comuns

Abaixo está uma lista abrangente de meta tags que você pode adicionar ao seu docs.json. Essas meta tags ajudam a melhorar o SEO do seu site, o compartilhamento social e a compatibilidade do navegador.

Você pode visualizar como suas meta tags aparecerão em diferentes plataformas usando metatags.io.

"seo": {
    "metatags": {
      "robots": "noindex",
      "charset": "UTF-8",
      "viewport": "width=device-width, initial-scale=1.0",
      "description": "Page description",
      "keywords": "keyword1, keyword2, keyword3",
      "author": "Author Name",
      "robots": "index, follow",
      "googlebot": "index, follow",
      "google": "notranslate",
      "google-site-verification": "verification_token",
      "generator": "Mintlify",
      "theme-color": "#000000",
      "color-scheme": "light dark",
      "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": "App Title",
      "application-name": "App Name",
      "msapplication-TileColor": "#000000",
      "msapplication-TileImage": "path/to/tile.png",
      "msapplication-config": "path/to/browserconfig.xml",
      "og:title": "Open Graph Title",
      "og:type": "website",
      "og:url": "https://example.com",
      "og:image": "https://example.com/image.jpg",
      "og:description": "Open Graph Description",
      "og:site_name": "Site Name",
      "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": "Twitter Title",
      "twitter:description": "Twitter Description",
      "twitter:image": "https://example.com/image.jpg",
      "twitter:image:alt": "Image Description",
      "twitter:player": "https://example.com/player",
      "twitter:player:width": "480",
      "twitter:player:height": "480",
      "twitter:app:name:iphone": "App Name",
      "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": "Author Name",
      "article:section": "Technology",
      "article:tag": "tag1, tag2, tag3",
      "book:author": "Author Name",
      "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": "Album Name",
      "music:album:disc": "1",
      "music:album:track": "1",
      "music:musician": "Artist Name",
      "music:song": "Song Name",
      "music:song:disc": "1",
      "music:song:track": "1",
      "video:actor": "Actor Name",
      "video:actor:role": "Role Name",
      "video:director": "Director Name",
      "video:writer": "Writer Name",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "tag1, tag2, tag3",
      "video:series": "Series Name"
  }
}