Sitemap

By Sheriff Docs ~ 7 min read

Sheriff automatically generates a sitemap.xml file for every portal that has a configured site_url.

A sitemap is an XML document that tells search engines which pages exist on your website. This helps search engines discover and index your content.

Enabling Sitemaps

To enable sitemap generation, add a site_url to the routing section of your portal's config.yall file.

routing:
  site_url: "https://example.com"

routing:
  site_url: "https://example.com"

Without a site_url, Sheriff cannot generate a sitemap because search engines require complete URLs.

When you build your portal, Sheriff automatically generates the following files:

dist/
└── sheriff/
    ├── sitemap.xml
    └── robots.txt

dist/
└── sheriff/
    ├── sitemap.xml
    └── robots.txt

If your portal has a different name, the files will be generated inside that portal's output directory instead.

Sheriff generates your sitemap automatically from your portal's routes.json file.

Every page that Sheriff builds is automatically included. There is nothing else you need to configure.

Sheriff also generates a robots.txt file alongside your sitemap.

A typical generated file looks like this:

User-agent: *
Allow: /

Sitemap: https://example.com/sitemap.xml

User-agent: *
Allow: /

Sitemap: https://example.com/sitemap.xml

This tells search engines where to find your sitemap.

Once your site is published, your sitemap will be available at:

https://example.com/sitemap.xml

https://example.com/sitemap.xml

You can submit this URL to search engines such as Google Search Console to help them discover your pages.

The following module participates in sitemap generation: