Skip to content

docs: sitemap, social previews, favicon, robots.txt - #15

Merged
matt-rolley merged 1 commit into
mainfrom
docs/seo-polish
Apr 21, 2026
Merged

matt-rolley merged 1 commit into
mainfrom
docs/seo-polish

Conversation

@matt-rolley

Copy link
Copy Markdown
Contributor

Summary

Polish pass so the deployed docs site has a proper SEO and social surface.

What's added

  • sitemap.xml — generated by VitePress's built-in sitemap option (no plugin). Uses git-derived `lastmod`. 30 URLs.
  • Open Graph + Twitter card meta — shared `og.png` (1200×630) applied to every page. Per-page `og:title` / `og:description` / `og:url` / canonical via `transformHead` reading each page's frontmatter.
  • favicon.png at `docs/public/favicon.png`.
  • robots.txt pointing crawlers at the sitemap.
  • `lastUpdated: true` so the VitePress footer shows "Last updated" per page.

Placeholder OG image

`docs/public/og.png` is a simple programmatically-generated image: dark background, "nuxt-c15t" + tagline in sans-serif, accent bar. Replace with a designed version when you have one — no config change needed, the filename stays the same. Same for the favicon.

Verifying

After deploy:

Test plan

  • `pnpm docs:build` — clean, sitemap generates with 30 URLs.
  • Spot-checked built HTML — canonical, og:, twitter: all populated per page.
  • Post-merge: verify on live site (needs deploy).

- sitemap.xml generated at build via VitePress's built-in sitemap
  option (no plugin needed since 1.2). Uses git-derived lastmod.
- head block adds OG + Twitter card meta, wiring through a shared
  1200x630 og.png.
- transformHead populates per-page canonical, og:url, og:title,
  og:description, twitter:title, twitter:description from each
  page's frontmatter.
- Simple favicon.png at docs/public/favicon.png.
- robots.txt points crawlers at the sitemap.
- Enabled lastUpdated so the VitePress footer shows last-edit times.

Generated assets kept minimal — OG image is a placeholder; replace
docs/public/og.png when a designed one is available.
@vercel

vercel Bot commented Apr 21, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nuxt-c15t Ready Ready Preview, Comment Apr 21, 2026 10:09am
nuxt-c15t-playground Ready Ready Preview, Comment Apr 21, 2026 10:09am

Request Review

@matt-rolley
matt-rolley merged commit ebb1ae8 into main Apr 21, 2026
4 checks passed
@matt-rolley
matt-rolley deleted the docs/seo-polish branch April 21, 2026 10:11

This branch was successfully deployed

2 active deployments
Preview – nuxt-c15t-playground — ba7bab07 Deployed Apr 21, 2026 by vercel[bot]
Preview – nuxt-c15t — ba7bab07 Deployed Apr 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant