Mintlify gestisce automaticamente molte best practice SEO, tra cui:
  • Generazione dei meta tag
  • Generazione della sitemap e del file robots.txt
  • Struttura HTML semantica
  • Ottimizzazione per dispositivi mobili
Puoi personalizzare completamente i meta tag del tuo sito aggiungendo il campo metatags al file docs.json o al frontmatter di una pagina.

Meta tag globali

Puoi impostare meta tag predefiniti aggiungendo il campo metadata al tuo docs.json.
"seo": {
    "metatags": {
        "og:image": "link all'immagine predefinita del meta tag"
    }
}

Meta tag specifici della pagina

Aggiungi i meta tag ai metadati della pagina in questo modo:
---
title: 'Your Example Page Title'
'og:image': 'link to your meta tag image'
---
I meta tag che contengono i due punti devono essere racchiusi tra virgolette quando li inserisci nei metadati della pagina.

Riferimento ai meta tag comuni

Di seguito trovi un elenco completo di meta tag che puoi aggiungere al tuo docs.json. Questi meta tag contribuiscono a migliorare la SEO del sito, la condivisione sui social e la compatibilità con i browser. Puoi vedere un’anteprima di come appariranno i meta tag sulle diverse piattaforme usando metatags.io.
"seo": {
    "metatags": {
      "robots": "noindex",
      "charset": "UTF-8",
      "viewport": "width=device-width, initial-scale=1.0",
      "description": "Descrizione della pagina",
      "keywords": "parola chiave 1, parola chiave 2, parola chiave 3",
      "author": "Nome autore",
      "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": "generale",
      "revisit-after": "7 giorni",
      "language": "en",
      "copyright": "Copyright 2024",
      "reply-to": "email@example.com",
      "distribution": "globale",
      "coverage": "In tutto il mondo",
      "category": "Tecnologia",
      "target": "tutti",
      "HandheldFriendly": "True",
      "MobileOptimized": "320",
      "apple-mobile-web-app-capable": "yes",
      "apple-mobile-web-app-status-bar-style": "black",
      "apple-mobile-web-app-title": "Titolo app",
      "application-name": "Nome app",
      "msapplication-TileColor": "#000000",
      "msapplication-TileImage": "path/to/tile.png",
      "msapplication-config": "path/to/browserconfig.xml",
      "og:title": "Titolo Open Graph",
      "og:type": "website",
      "og:url": "https://example.com",
      "og:image": "https://example.com/image.jpg",
      "og:description": "Descrizione Open Graph",
      "og:site_name": "Nome del sito",
      "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": "Titolo Twitter",
      "twitter:description": "Descrizione Twitter",
      "twitter:image": "https://example.com/image.jpg",
      "twitter:image:alt": "Descrizione immagine",
      "twitter:player": "https://example.com/player",
      "twitter:player:width": "480",
      "twitter:player:height": "480",
      "twitter:app:name:iphone": "Nome 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 autore",
      "article:section": "Tecnologia",
      "article:tag": "tag1, tag2, tag3",
      "book:author": "Nome autore",
      "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 album",
      "music:album:disc": "1",
      "music:album:track": "1",
      "music:musician": "Nome artista",
      "music:song": "Titolo canzone",
      "music:song:disc": "1",
      "music:song:track": "1",
      "video:actor": "Nome attore",
      "video:actor:role": "Ruolo",
      "video:director": "Nome regista",
      "video:writer": "Nome sceneggiatore",
      "video:duration": "120",
      "video:release_date": "2024-01-01",
      "video:tag": "tag1, tag2, tag3",
      "video:series": "Nome serie"
  }
}

Sitemap e file robots.txt

Mintlify genera automaticamente un file sitemap.xml e un file robots.txt. Puoi visualizzare la sitemap aggiungendo /sitemap.xml all’URL del tuo sito di documentazione. Per impostazione predefinita vengono incluse solo le pagine presenti nel docs.json. Per includere i link nascosti, aggiungi seo.indexing al docs.json:
"seo": {
    "indexing": all
}

Sitemap personalizzati e file robots.txt

Per aggiungere un sitemap.xml o un robots.txt personalizzato, crea un file sitemap.xml o robots.txt nella directory principale del progetto. L’aggiunta di un file personalizzato sovrascriverà il file generato automaticamente con lo stesso nome. Se elimini il file personalizzato, verrà nuovamente utilizzato quello predefinito.

Disabilitare l’indicizzazione

Se vuoi impedire che una pagina venga indicizzata dai motori di ricerca, puoi includere quanto segue nel frontmatter della pagina:
---
noindex: true
---
Puoi anche applicare noindex a tutte le pagine della documentazione impostando il campo metadata.robots su "noindex" nel file docs.json:
"seo": {
  "metatags": {
    "robots": "noindex"
  }
}

Best practice SEO