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.
See the editor guide for more information.
The command below will install Sitemaps into your Optimizely project.
dotnet add package Geta.Optimizely.Sitemaps
The command below will install Sitemaps Commerce support into your Optimizely Commerce project.
dotnet add 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;
});
You can configure access to the sitemaps configuration tab by adding a custom policy (the default is WebAdmins):
services.AddSitemaps(x =>
{
x.EnableLanguageDropDownInAdmin = false;
x.EnableRealtimeCaching = true;
x.EnableRealtimeSitemap = false;
}, p => p.RequireRole(Roles.Administrators));
And for the Commerce support add a call to:
services.AddSitemapsCommerce();
In order to augment Urls for a given set of content one must prepare to build a service that identifies content to be augmented and yields augmented Uris from IUriAugmenterService.GetAugmentUris(IContent content, CurrentLanguageContent languageContentInfo, Uri fullUri) method.
services.AddSitemaps(options =>
{
options.SetAugmenterService<SitemapUriParameterAugmenterService>();
});
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();
});
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>();
See CONTRIBUTING.md