Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geta/seo.sitemaps

Search engine sitemaps.xml for EPiServer CMS
https://github.com/geta/seo.sitemaps

cms commerce marketing

Last synced: about 2 months ago
JSON representation

Search engine sitemaps.xml for EPiServer CMS

Host: GitHub
URL: https://github.com/geta/seo.sitemaps
Owner: Geta
License: apache-2.0
Created: 2012-10-01T08:06:15.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2022-09-01T00:46:24.000Z (over 2 years ago)
Last Synced: 2023-04-10T16:50:56.674Z (almost 2 years ago)
Topics: cms, commerce, marketing
Language: C#
Size: 136 MB
Stars: 26
Watchers: 30
Forks: 42
Open Issues: 46
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # SEO.Sitemaps

* Master


![](http://tc.geta.no/app/rest/builds/buildType:(id:GetaPackages_GetaSeoSitemaps_00ci),branch:master/statusIcon)

* Develop


![](http://tc.geta.no/app/rest/builds/buildType:(id:GetaPackages_GetaSeoSitemaps_00ci),branch:develop/statusIcon)


[![Platform](https://img.shields.io/badge/Platform-.NET%204.6.1-blue.svg?style=flat)](https://msdn.microsoft.com/en-us/library/w0x726c2%28v=vs.110%29.aspx)

[![Platform](https://img.shields.io/badge/Episerver-%2011-orange.svg?style=flat)](http://world.episerver.com/cms/)

Search engine sitemaps.xml for EPiServer CMS 11 and Commerce 13

## Description

This tool allows you to generate xml sitemaps for search engines to better index your EPiServer sites. Although there are several EPiServer sitemap tools available like [SearchEngineSitemaps](https://www.coderesort.com/p/epicode/wiki/SearchEngineSitemaps) and [EPiSiteMap](http://episitemap.codeplex.com/) which have inspired this project this tool gives you some additional specific features.

## Features

- 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](docs/editor-guide.md) for more information.

## Latest release

The latest version is available on the EPiServer NuGet feed. You can find it by searching the term Geta.SEO.Sitemaps.

## Download

From nuget.episerver.com feed.

## How to get started?

1. Install Sitemap plugin via NuGet in Visual Studio. Ensure that you also install the required dependencies.

```

  Install-Package Geta.SEO.Sitemaps

  Install-Package Geta.SEO.Sitemaps.Commerce

```

2. Rebuild your solution.

3. Configure sitemap settings and schedule the sitemap generation process. Configuration available at CMS -> Admin Mode -> Search engine sitemap settings. See the [editor guide](docs/editor-guide.md)

#### Enabling multi language support

Add this to your web.config file:

```xml

  

    

  

```

### Dynamic property for specific pages

You can specify page specific sitemap properties (like change frequency, priority or include/disinclude the specific page in any sitemap) for each EPiServer page by defining a dynamic property with type SEOSitemaps (and the same name):

![Create dynamic property](docs/images/SitemapDynamicPropertyDefine.png?raw=true)

and specify values for the dynamic property:

![Set value for the dynamic property](docs/images/SitemapDynamicPropertyOnPage.PNG?raw=true)

### Adding Sitemap Properties to all content pages

Credits to [jarihaa](https://github.com/jarihaa) for [contributing](https://github.com/Geta/SEO.Sitemaps/pull/87) this.

```

[UIHint("SeoSitemap")]

[BackingType(typeof(PropertySEOSitemaps))]

public virtual string SEOSitemaps { get; set; }

```

#### Set default value

```

public override void SetDefaultValues(ContentType contentType)

{

    base.SetDefaultValues(contentType);

    var sitemap = new PropertySEOSitemaps

    {

        Enabled = false

    };

    sitemap.Serialize();

    this.SEOSitemaps = sitemap.ToString();

}

```

### Ignore page types

Implement the `IExcludeFromSitemap` interface to ignore page types in the sitemap.

```

public class OrderConfirmationPage : PageData, IExcludeFromSitemap

```

### Exclude content

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();```

## Limitations

- Each sitemap will contain max 50k entries (according to [sitemaps.org protocol](http://www.sitemaps.org/protocol.html#index)) 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).

## Local development setup

See description in [shared repository](https://github.com/Geta/package-shared/blob/master/README.md#local-development-set-up) regarding how to setup local development environment.

### Docker hostnames

Instead of using the static IP addresses the following hostnames can be used out-of-the-box.

- http://sitemaps.getalocaltest.me

- http://manager-sitemaps.getalocaltest.me

### QuickSilver login

Use the default [email protected] user for QuickSilver, see [Installation](https://github.com/episerver/Quicksilver).

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md)

## Package maintainer

https://github.com/frederikvig

## Changelog

[Changelog](CHANGELOG.md)