SEO
Enhance your documentation's search engine visibility with custom meta tags
Our documentation platform provides automatic meta tag generation, but you have a full control to customize them through the docs.json configuration or individual page meta.
Global Meta Tags
Set default meta tags for your entire documentation by adding the seo.metatags section to your docs.json:
Page-specific Meta Tags
Customize meta tags for individual pages using page meta:
When using meta tags containing colons (like og:image), remember to wrap them in quotes in your frontmatter.
Sitemaps
Your documentation automatically includes:
- A
sitemap.xmlfile (accessible at/sitemap.xml) - A
robots.txtfile
For good sitemap.xml generation make sure you filled seo.domain.
Controlling Indexing
To prevent search engines from indexing specific pages, add to the page's frontmatter:
For site-wide indexing control, set in docs.json:
Meta Tags Reference
Here's a curated list of the most important meta tags you can use to optimize your documentation:
You can preview how your meta tags will appear on different platforms using metatags.io.
Show your support! Star us on GitHub ⭐️