Search engine sitemaps.xml for Optimizely CMS 12 and Commerce 14
This tool allows you to generate xml sitemaps for search engines to better index your Optimizely sites.
- sitemap generation as a scheduled job
- filtering pages by virtual directories
- ability to include pages that are in a different branch than the one of the start page
- ability to generate sitemaps for mobile pages
- it also supports multi-site and multi-language environments
See the editor guide for more information.
The latest version is available on the Optimizely NuGet feed. You can find it by searching the term Geta.Optimizely.Sitemaps.
The command below will install Sitemaps into your Optimizely project.
Install-Package Geta.Optimizely.Sitemaps
The command below will install Sitemaps Commerce support into your Optimizely Commerce project.
Install-Package Geta.Optimizely.Sitemaps.Commerce
For the Sitemaps to work, you have to call AddSitemaps extension method in Startup.ConfigureServices method. This method provides a configuration of default values. Below is a code with all possible configuration options:
services.AddSitemaps(x =>
{
x.EnableLanguageDropDownInAdmin = false;
x.EnableRealtimeCaching = true;
x.EnableRealtimeSitemap = false;
});And for the Commerce support add a call to:
services.AddSitemapsCommerce();It is also possible to configure the application in appsettings.json file. A configuration from the appsettings.json will override configuration configured in Startup. Below is an appsettings.json configuration example.
"Geta": {
"Sitemaps": {
"EnableLanguageDropDownInAdmin": true
}
}Also, you have to add Razor pages routing support.
app.UseEndpoints(endpoints =>
{
endpoints.MapRazorPages();
});
You can specify page specific sitemap properties (like change frequency, priority or include/disinclude the specific page in any sitemap) for each Optimizely page by defining a dynamic property with type SEOSitemaps (and the same name):
and specify values for the dynamic property:
Credits to jarihaa for contributing this.
[UIHint("SeoSitemap")]
[BackingType(typeof(PropertySEOSitemaps))]
public virtual string SEOSitemaps { get; set; }
public override void SetDefaultValues(ContentType contentType)
{
base.SetDefaultValues(contentType);
var sitemap = new PropertySEOSitemaps
{
Enabled = false
};
sitemap.Serialize();
this.SEOSitemaps = sitemap.ToString();
}
Implement the IExcludeFromSitemap interface to ignore page types in the sitemap.
public class OrderConfirmationPage : PageData, IExcludeFromSitemap
If you need more control to exclude content from the sitemap you can make your own implementation of IContentFilter. Make sure to inherit from ContentFilter and call the ShouldExcludeContent method of the base class.
public class SiteContentFilter : ContentFilter
{
public override bool ShouldExcludeContent(IContent content)
{
if (base.ShouldExcludeContent(content))
{
return true;
}
// Custom logic here
return false;
}
}
Register in your DI container.
services.AddTransient<IContentFilter, SiteContentFilter>();- Each sitemap will contain max 50k entries (according to sitemaps.org protocol) so if the site in which you are using this plugin contains more active pages then you should split them over multiple sitemaps (by specifying a different root page or include/avoid paths for each).
See description in shared repository regarding how to setup local development environment.
Instead of using the static IP addresses the following hostnames can be used out-of-the-box.
Use the default [email protected] user for QuickSilver, see Installation.
See CONTRIBUTING.md