Yasl.Net.SitemapMiddleware 1.1.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Yasl.Net.SitemapMiddleware --version 1.1.0
                    


                    

                
NuGet\Install-Package Yasl.Net.SitemapMiddleware -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Yasl.Net.SitemapMiddleware" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Yasl.Net.SitemapMiddleware" Version="1.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Yasl.Net.SitemapMiddleware" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Yasl.Net.SitemapMiddleware --version 1.1.0
                    


                    

                
#r "nuget: Yasl.Net.SitemapMiddleware, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Yasl.Net.SitemapMiddleware@1.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Yasl.Net.SitemapMiddleware&version=1.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Yasl.Net.SitemapMiddleware&version=1.1.0
                    


                            Install as a Cake Tool

SitemapMiddleware

SitemapMiddleware is a middleware component for generating and serving sitemaps in a web application. This project helps in improving the SEO of your website by providing an up-to-date sitemap.

Features

  • Automatically generates sitemaps for your web application.
  • Optionally serves robots.txt with a sitemap directive.
  • Easy integration with existing web frameworks.

Installation

To install SitemapMiddleware, use the following command:

dotnet add package Yasl.Net.SitemapMiddleware

Usage

To use this middleware, add it to the request pipeline in the Startup.cs file:

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseSitemapMiddleware("https://example.com", options =>
    {
        options.ServeRobotsTxt = true;
        options.RobotsTxtAdditionalLines.Add("Clean-param: etext");
    });

    // other middlewares
}

This serves:

  • /sitemap.xml
  • /robots.txt when ServeRobotsTxt is enabled

The root URL must be an absolute http or https URL. File URLs and empty values are rejected.

The legacy registration style is still supported:

app.UseMiddleware<SitemapMiddleware>("https://example.com");

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or suggestions, please open an issue on GitHub.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 158 6/15/2026
1.0.6 314 11/24/2024