diff --git a/settings/seo.mdx b/settings/seo.mdx index 47b6054d..659aed17 100644 --- a/settings/seo.mdx +++ b/settings/seo.mdx @@ -1,12 +1,17 @@ --- -title: 'SEO' -description: 'Extend default meta tags for better SEO' -icon: 'search' +title: "SEO" +description: "SEO best practices and meta tag configuration for better search visibility" +icon: "search" --- -The platform automatically generates most meta tags. +Mintlify automatically handles many SEO best practices, including: -However, you can fully customize them by adding the `metatags` field to your `docs.json` or the page's frontmatter. +- Meta tag generation +- Sitemap and `robots.txt` file generation +- Semantic HTML structure +- Mobile optimization + +You can fully customize your site's meta tags by adding the `metatags` field to your `docs.json` or a page's frontmatter. ## Global meta tags @@ -35,44 +40,12 @@ title: 'Your Example Page Title' Meta tags with colons need to be typed with quotes around them when you put them in the page metadata. -## Sitemaps - -Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. Simply navigate to `/sitemap.xml` to see your sitemap. - -Only pages included in your `docs.json` are included by default. To include hidden links, add `seo.indexing` to your `docs.json`: - -```json -"seo": { - "indexing": all -} -``` - -## Disabling indexing - -If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](pages) of your page: - -``` ---- -noindex: true ---- -``` - -You can also specify `noindex` for all pages in your docs by setting the `metadata.robots` field to `"noindex"` in your `docs.json`: - -```json -"seo": { - "metatags": { - "robots": "noindex" - } - } -``` - ## Common Meta Tags Reference Below is a comprehensive list of meta tags you can add to your `docs.json`. These meta tags help improve your site's SEO, social sharing, and browser compatibility. You can preview how your meta tags will appear on different platforms using [metatags.io](https://metatags.io/). -```json +```json expandable "seo": { "metatags": { "robots": "noindex", @@ -165,3 +138,67 @@ You can preview how your meta tags will appear on different platforms using [met } ``` +## Sitemaps + +Mintlify automatically generates a `sitemap.xml` file and a `robots.txt` file. Simply navigate to `/sitemap.xml` to see your sitemap. + +Only pages included in your `docs.json` are included by default. To include hidden links, add `seo.indexing` to your `docs.json`: + +```json +"seo": { + "indexing": all +} +``` + +## Disabling indexing + +If you want to stop a page from being indexed by search engines, you can include the following in the [frontmatter](pages) of your page: + +``` +--- +noindex: true +--- +``` + +You can also specify `noindex` for all pages in your docs by setting the `metadata.robots` field to `"noindex"` in your `docs.json`: + +```json +"seo": { + "metatags": { + "robots": "noindex" + } + } +``` + +## SEO best practices + + + +- Use clear, descriptive page titles (50-60 characters) +- Write compelling descriptions (150-160 characters) +- Include relevant keywords +- Make each page title and description unique + + + +- Use proper heading hierarchy (H1 → H2 → H3) +- Write for humans first, search engines second +- Include relevant keywords in headings and content +- Keep URLs short, descriptive, and organized hierarchically +- Break up long content with subheadings and lists + + + +- Link to related pages within your documentation +- Use descriptive anchor text instead of "click here" +- Create topic clusters by linking related concepts +- Use the automatic cross-referencing features + + + +- Use descriptive file names for images +- Always include alt text for accessibility and SEO +- Optimize image file sizes for faster loading +- Use relevant images that support your content + +