SEO

Tiramisu Docs inclut des fonctionnalités SEO intégrées pour aider votre documentation à bien se positionner dans les moteurs de recherche.

Sitemap

Un sitemap est automatiquement généré à /sitemap.xml. Il inclut toutes les pages de documentation avec leurs dates de dernière modification.

Pour activer le sitemap, définissez le champ url dans votre configuration :

export default defineConfig({
  url: "https://docs.example.com",
  // ...
});

Le url est requis pour générer des URL absolues dans le sitemap.

Balises meta

Chaque page de documentation obtient automatiquement des balises meta dérivées de son bloc meta {} :

Open Graph

• og:title — issu du titre de la page
• og:description — issu de la description de la page
• og:type — toujours article
• og:url — URL canonique construite à partir du url de votre site et du slug de la page
• og:site_name — issu du title dans votre configuration
• og:image — issu du champ image dans les métadonnées de la page

Twitter Cards

• twitter:card — summary_large_image lorsqu'une image est définie, sinon summary
• twitter:title — issu du titre de la page
• twitter:description — issu de la description de la page
• twitter:image — issu du champ image dans les métadonnées de la page

Image OG

Vous pouvez définir une image Open Graph par page en utilisant le champ image dans le bloc meta {} de la page :

meta {
  title = Getting Started,
  description = Learn how to get started,
  image = /images/getting-started.png
}

Le chemin de l'image peut être relatif à la racine de votre site (par ex. /images/hero.png) ou une URL absolue (par ex. https://example.com/og.png). Les chemins relatifs sont résolus par rapport au url de votre site.

URL canonique

Une balise <link rel=canonical> est ajoutée à chaque page lorsqu'un url de site est configuré. Cela aide les moteurs de recherche à identifier l'URL préférée pour chaque page.

Données structurées JSON-LD

Chaque page inclut un schéma JSON-LD TechArticle avec :

• headline — le titre de la page
• url — l'URL canonique de la page
• mainEntityOfPage — une référence WebPage
• isPartOf — une référence WebSite avec le nom et l'URL de votre site
• description — si une description est définie dans les métadonnées de la page
• dateModified — si le suivi des dernières modifications est activé
• image — si une image est définie dans les métadonnées de la page
• author — si un auteur est défini dans les métadonnées de la page (en tant qu'entité Person)

Toutes ces balises sont générées automatiquement. Vous devez uniquement définir url et title dans votre configuration et ajouter title et description au bloc meta {} de chaque page.

Personnaliser le sitemap

La route du sitemap est incluse automatiquement lorsque vous créez un projet avec le scaffolder. Si vous avez besoin de la personnaliser, la route générée se trouve à src/routes/sitemap.xml/+server.ts et utilise la fonction generateSitemap() du kit.