SEO

The engine handles most SEO for you — canonical URLs, meta tags, and per-page social images are generated automatically. A couple of settings are worth knowing about.

siteUrl & sitemap

Set siteUrl to your site's public URL. It's used for the sitemap, canonical links, and absolute URLs in social cards:

{ "siteUrl": "https://docs.acme.com" }

robots & noindex

Keep specific path prefixes out of search engines. They're excluded from the sitemap and marked noindex:

{
  "seo": {
    "noindex": ["/internal", "/es"]
  }
}

Social images

Every page gets an Open Graph image generated from its title and your brand color, so links unfurl nicely in Slack, iMessage, and social. Set a site-wide default with ogImage (a path under public/) if you'd rather use your own:

{ "ogImage": "/og/default.png" }