TinySitemapGenerator 1.0.6

TinySitemapGenerator

Author: Ryan Kueter
Updated: December, 2024

About

TinySitemapGenerator is a free .NET library available from the NuGet Package Manager that provides a simple way to create a sitemap or a sitemap index for your website.

Targets:

• .NET 8 - .NET 9

Introduction

The TinySitemapGenerator provides the following options for automatically generating an XML sitemap.

// Create a new sitemap
var sitemap = new Sitemap();

// Optionally add the xsd reference for validation
sitemap.ValidateMap = true;

// Specify the file path
sitemap.Filepath = @"C:\wwwroot";

// Add optional namespaces
sitemap.SitemapOptionalNamespaces.Add(SitemapOptionalNamespace.News);

// Add Sitemap Urls
sitemap.SitemapUrls.Add(
    new SitemapUrl { 
        Location = "https://www.mysite.com/article/tutorial.html",
        LastModified = DateTime.Now,
        Priority = SitemapPriorities.Nine,
        ChangeFrequency = SitemapChangeFrequencies.Never
    }
);

// Asychronous Methods

// Generate a standard XML sitemap
await sitemap.SaveSitemapAsync();

// Generate a XML sitemap index because
// you have more than 50,000 urls or your
// files exceed 50MB
await sitemap.SaveSitemapIndexAsync();

// Get the file bytes
var bytes = await sitemap.GetSitemapBytesAsync();
await File.WriteAllBytesAsync(Path.Combine(@"C:\wwwroot", "sitemap.xml"), bytes);

// Generate a XML sitemap index because
// you have more than 50,000 urls or your
// files exceed 50MB
var bytes = await sitemap.GetSitemapIndexBytesAsync();
await File.WriteAllBytesAsync(Path.Combine(@"C:\wwwroot", "sitemap.xml"), bytes);

// Sychronous Methods

// Generate a standard XML sitemap
sitemap.SaveSitemap();

// Generate a XML sitemap index because
// you have more than 50,000 urls or your
// files exceed 50MB
sitemap.SaveSitemapIndex();

// Get the file bytes
var bytes = sitemap.GetSitemapBytes();
File.WriteAllBytes(Path.Combine(@"C:\wwwroot", "sitemap.xml"), bytes);

// Generate a XML sitemap index because
// you have more than 50,000 urls or your
// files exceed 50MB
var bytes = sitemap.GetSitemapIndexBytes();
File.WriteAllBytes(Path.Combine(@"C:\wwwroot", "sitemap.xml"), bytes);

Contributions

This project is being developed for free by me, Ryan Kueter, in my spare time. So, if you would like to contribute, please submit your ideas on the Github project page.