Writerside Help

Generate sitemap

Writerside can generate a sitemap of your help website. It provides information about the content to help search engines crawl your site more efficiently.

Enable sitemap generation

By default, Writerside does not generate a sitemap.

  1. In your documentation project, open buildprofiles.xml or create it if you do not have it yet.

  2. Add the <sitemap> tag with optional attributes that set the priority and change frequency.

    <buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sitemap priority="0.35" change-frequency="monthly"/> </buildprofiles>

When enabled, Writerside generates a sitemap.xml file that contains URLs and other information about all built topic files:

<url> <loc>https://www.jetbrains.com/help/writerside/discover-writerside.html</loc> <lastmod>2024-01-02</lastmod> <changefreq>monthly</changefreq> <priority>0.35</priority> </url>

For example, see https://www.jetbrains.com/help/writerside/sitemap.xml.

Last modified: 14 March 2024