https://github.com/stormid/sitemapify
Provides a ASP.NET HttpHandler to assist with generating a dynamic sitemap.xml file
https://github.com/stormid/sitemapify
asp csharp http-handler sitemap umbraco
Last synced: about 1 month ago
JSON representation
Provides a ASP.NET HttpHandler to assist with generating a dynamic sitemap.xml file
- Host: GitHub
- URL: https://github.com/stormid/sitemapify
- Owner: stormid
- License: mit
- Created: 2016-08-12T08:52:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T03:43:41.000Z (over 2 years ago)
- Last Synced: 2025-03-05T15:51:44.695Z (about 2 months ago)
- Topics: asp, csharp, http-handler, sitemap, umbraco
- Language: C#
- Size: 495 KB
- Stars: 3
- Watchers: 5
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sitemapify
Provides a ASP.NET HttpHandler to assist with generating a dynamic sitemap.xml file
There is also an Umbraco specific extension to Sitemapify that supports building the sitemap from Umbraco CMS content. See [Sitemapify.Umbraco](#sitemapifyumbraco-configuration) for further documentation
## Installation
```
Install-Package Sitemapify
```
The installation process should have updated your web.config file to include a httphandler to process requests to `sitemap.xml`, it should look similar to:
```xml
```
## Customisation
The sitemap handler can be customised by altering the base configuration via the ```Sitemapify.Configure``` static configuration class.
```c#
Sitemapify.Configure(c => c
.UsingContentProvider(new YourContentProvider())
.UsingCacheProvider(new YourCacheProvider())
.UsingDocumentBuilder(new YourDocumentBuilder())
);
```
Sitemapify is split into providers that are responsible for elements of the sitemap generation.
### Content Provider (`ISitemapifyContentProvider`)
An implementation of a content provider supplies Sitemapify with a collection of `SitemapUrl` objects representing the nodes to output within the sitemap.
```c#
public interface ISitemapContentProvider
{
IEnumerable GetSitemapUrls();
bool Cacheable { get; }
DateTime CacheUntil { get; }
}
```
### Cache Provider (`ISitemapifyCacheProvider`)
An implementation of a cache provider allows customisation of the caching mechanism used to optimise delivery of the sitemap to the browser. Once the sitemap document is generated it will be cached via the configured implementation of this interface.
```c#
public interface ISitemapCacheProvider
{
void Add(XDocument sitemapContent, DateTimeOffset? expires);
bool IsCached { get; }
XDocument Get();
void Remove();
}
```
### Document Builder (`ISitemapDocumentBuilder`)
An implementation of the `ISitemapDocumentBuilder` provides allows full customisation of the sitemap document itself. The default implementation generates a fully compliant sitemap document based on the official [sitemap.xsd](http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd).
```c#
public interface ISitemapDocumentBuilder
{
XDocument BuildSitemapXmlDocument(IEnumerable sitemapUrls);
}
```
## Sitemapify.Umbraco Configuration
_This version of Sitemapify.Umbraco supports Umbraco 8.1+. For Umbraco v7.* support, please refer to [version 0.5.2](https://github.com/stormid/sitemapify/releases/tag/0.5.2)._
Firstly install the Umbraco extension:
```
Install-Package Sitemapify.Umbraco
```
Once you have installed Sitemapify.Umbraco you can create an Component to configure Sitemapify to use the available "Umbraco Content Provider" to generate sitemap url that form the sitemap.xml.
```c#
public class SitemapifyComponent : IComponent
{
public void Initialize()
{
Configure.With(config => config.UsingContentProvider(new SitemapifyUmbracoContentProvider()));
}
public void Terminate() { }
}
```
You'll also need to create a UserComposer to register the Component.
```c#
public class SitemapifyComposer : IUserComposer
{
public void Compose(Composition composition)
{
composition.Components().Append();
}
}
```
By default the Umbraco content provider will look for content node properties with specific names to determine whether a particular node should be included in the generated sitemap file, these property names are:
* `umbracoNaviHide` - True/False to determine whether this node is included (Default: false)
* `sitemapifyExcludeChildren` - True/False to determine whether to ignore all child nodes below this node (Default: false)
If you want to alter these property aliases you can override them via application settings:
```xml
```