Sitemap extension is normally one of the last in a pipeline, if used.
It will generate a
/sitemap.xml file which may be fed to search engines
for better SEO.
It simply scans all the pages in your site and generates your sitemap for you.
If there are URLs on your site that are not handled by awestruct, for example
URLs that are managed with
.htaccess RewriteRules, you can add those in
_config/sitemap.yml as shown.
pages: - url: /2x/builds/html-docs/ change_frequency: daily priority: 1 - url: /1.1.x/builds/html-docs change_frequency: monthly priority: 0.5
priority should correspond to those
allowed in the sitemap protocol.
As with the sitemap protocol,
priority for your pages defaults to 0.5.
You may set this, and the
change_frequency value in the front matter
for each page or template. If set in the template, all pages rendered with
that template will be affected. The default for
As your site gets more complex you may want to exclude more content from your sitemap. By adding some configuration to the sitemap.yml you can exclude all files by extension or individual files by their full path in the generated site.
excluded_extensions: ['.pdf'] excluded_files: [ '/success_form.html', '/assets/hidden-file.csv' ]
By default the following are excluded from the sitemap
excluded_files: [ '/.htaccess', '/favicon.ico' ,'/robots.txt', ] excluded_extensions: ['.atom', '.scss', '.css', '.png', '.jpg', '.gif', '.js' ]
To include an optional stylesheet for your sitemap.xml file
To use the
Sitemap extension, simply configure it into your
Awestruct::Extensions::Pipeline.new do extension Awestruct::Extensions::Sitemap.new end
NOTE: If you use the
indexifier extension, you should ensure that the
sitemap extension appears after
indexifier in your
Awestruct::Extensions::Pipeline.new do extension Awestruct::Extensions::Sitemap.new() end