diff --git a/docs/reference/site-config.md b/docs/reference/site-config.md index 1cf9d726..f23082f8 100644 --- a/docs/reference/site-config.md +++ b/docs/reference/site-config.md @@ -645,6 +645,23 @@ export default { } ``` +#### Example: Adding a canonical URL `` + +```ts +export default { + transformHead({ page }) { + // Skip the 404 page + if (page !== '404.md') { + const canonicalUrl = `https://example.com/${page}` + .replace(/index\.md$/, '') + .replace(/\.md$/, '.html') + + return [['link', { rel: 'canonical', href: canonicalUrl }]] + } + } +} +``` + ### transformHtml - Type: `(code: string, id: string, context: TransformContext) => Awaitable`