For the complete documentation index, see llms.txt. Prefer markdown by appending.mdto documentation URLs or sendingAccept: text/markdown.
SEO
Page metadata, social previews, canonical URLs, a sitemap, and crawler rules for the public pages and content in your Edge app.
Edge Kit includes the foundations for search discovery and link sharing: page metadata, social previews, a sitemap, and crawler rules. Blog and legal pages use their content metadata, while application routes can define their own titles and descriptions.
Set your product identity through app configuration. The production VITE_URL supplies the origin for public URLs, so set it before building a release.
Metadata
Give each public page a descriptive title and summary. The existing metadata setup supports translated text and includes the product name, keeping route titles consistent with the rest of your app.
Canonical URLs identify the preferred address for a page. Set the canonical path on public routes where you need one; blog detail pages already derive it from the post.
A new public feature page can supply a focused set of metadata values to the existing page metadata setup:
const metadata = {
title: "Reporting",
description: "Turn your project data into shareable reports.",
canonical: "/features/reporting",
};The route and copy are examples for your product. Use translated messages for localized pages, and make the canonical path match the actual public destination.
Page purpose
Give each public destination a clear subject. The landing page explains the product, pricing explains the offer, and an article answers a more specific question. Their titles and summaries should reflect those differences rather than repeating the same product description everywhere.
Keep one main page heading and use shorter topic headings for the sections below it. Include the details a visitor needs to understand the page before following a registration or pricing link.
Social previews
Replace the default public/og.png with your product's social image, using a 1200 by 630 layout. Individual pages can use their own images, and blog posts use their configured thumbnail.
The branding guide covers logos, icons, and the other assets customers see.
Sitemap
The sitemap includes the public landing, pricing, contact, and blog pages, plus published articles and legal documents. Localized alternate links use your supported languages.
When adding a public page, include it in the sitemap and link to it from relevant navigation or content. Descriptive links help customers find the page as well as helping search engines understand its role. See Google's link guidance.
Languages
The sitemap uses your supported language configuration for alternate URLs. When adding a language or changing a public route, verify that each advertised destination resolves to the intended content.
Article translations share a slug but have their own copy and metadata. Review a localized page's canonical URL and social preview alongside its body, especially when it falls back to base-language content.
Internal links
Connect related content where it helps a visitor continue: an article can link to the feature it explains, a feature page can link to the relevant plan, and pricing can lead to registration or contact. Use link text that identifies the destination instead of repeating generic labels.
When renaming a public route, update shared navigation, article links, and sitemap entries together. Preserve an intentional redirect if an existing published URL needs to keep working. Navigation covers shared destinations and route changes.
Crawler rules
The included robots rules allow the public site and exclude app areas such as the dashboard, auth, and API. Review these rules when changing private paths or locale routing.
Private data
Crawler rules guide search engines. Session and ownership checks on the server protect customer data, as covered in security.
Verification
After deployment, check /robots.txt and /sitemap.xml on the final hostname. Inspect a public page and article for their title, description, canonical URL, localized alternates, and reachable preview image.
Confirm published articles appear and drafts stay out of public queries. TanStack Router's head management covers route metadata options.
How is this guide?
Last updated on