A Mintlify cuida automaticamente de muitas boas práticas de SEO, incluindo:
  • Geração de meta tags
  • Geração de sitemap e do arquivo robots.txt
  • Estrutura HTML semântica
  • Otimização para dispositivos móveis
Você pode personalizar completamente as meta tags do seu site adicionando o campo metatags ao seu docs.json ou ao frontmatter de uma página.

​
Metatags globais

Você pode definir metatags padrão adicionando o campo metadata ao seu docs.json. 
"seo": {
    "metatags": {
        "og:image": "link para a imagem padrão da sua meta tag"
    }
}

​
Metatags específicos da página

Adicione seus metatags aos metadados da página da seguinte forma: 
---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
---
Metatags que contêm dois-pontos precisam estar entre aspas quando forem adicionados aos metadados da página.

​
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 em redes sociais e a compatibilidade com navegadores. Você pode visualizar previamente 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": "Descrição da página",
      "keywords": "palavra-chave1, palavra-chave2, palavra-chave3",
      "author": "Nome do 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": "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 do app",
      "application-name": "Nome do app",
      "msapplication-TileColor": "#000000",
      "msapplication-TileImage": "path/to/tile.png",
      "msapplication-config": "path/to/browserconfig.xml",
      "og:title": "Título do Open Graph",
      "og:type": "website",
      "og:url": "https://example.com",
      "og:image": "https://example.com/image.jpg",
      "og:description": "Descrição do Open Graph",
      "og:site_name": "Nome do site",
      "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 do Twitter",
      "twitter:description": "Descrição do Twitter",
      "twitter:image": "https://example.com/image.jpg",
      "twitter:image:alt": "Descrição da imagem",
      "twitter:player": "https://example.com/player",
      "twitter:player:width": "480",
      "twitter:player:height": "480",
      "twitter:app:name:iphone": "Nome do 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": "Nome do autor",
      "article:section": "Tecnologia",
      "article:tag": "tag1, tag2, tag3",
      "book:author": "Nome do 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": "Nome do álbum",
      "music:album:disc": "1",
      "music:album:track": "1",
      "music:musician": "Nome do artista",
      "music:song": "Nome da música",
      "music:song:disc": "1",
      "music:song:track": "1",
      "video:actor": "Nome do ator",
      "video:actor:role": "Nome do papel",
      "video:director": "Nome do diretor",
      "video:writer": "Nome do roteirista",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "tag1, tag2, tag3",
      "video:series": "Nome da série"
  }
}

​
Sitemaps e arquivos robots.txt

A Mintlify gera automaticamente um arquivo sitemap.xml e um arquivo robots.txt. Você pode visualizar seu sitemap adicionando /sitemap.xml ao URL do seu site de documentação. Por padrão, apenas as páginas incluídas no seu docs.json são consideradas. Para incluir links ocultos, adicione seo.indexing ao seu docs.json: 
"seo": {
    "indexing": all
}

​
Sitemaps personalizados e arquivos robots.txt

Para adicionar um sitemap.xml ou robots.txt personalizado, crie um arquivo sitemap.xml ou robots.txt na raiz do seu projeto. Adicionar um arquivo personalizado substituirá o arquivo gerado automaticamente com o mesmo nome. Se você excluir um arquivo personalizado, o arquivo padrão voltará a ser usado.

​
Desativando a indexação

Se você quiser evitar que uma página seja indexada por mecanismos de busca, inclua o seguinte no frontmatter da página: 
---
noindex: true
---
Você também pode definir noindex para todas as páginas da documentação configurando o campo metadata.robots como "noindex" no arquivo docs.json: 
"seo": {
    "metatags": {
      "robots": "noindex"
    }
  }

​
Melhores práticas de SEO