SchemaRender.AspNetCore 1.0.0

There is a newer version of this package available.
See the version list below for details.

dotnet add package SchemaRender.AspNetCore --version 1.0.0

NuGet\Install-Package SchemaRender.AspNetCore -Version 1.0.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="SchemaRender.AspNetCore" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="SchemaRender.AspNetCore" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="SchemaRender.AspNetCore" />
                    

                            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 SchemaRender.AspNetCore --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: SchemaRender.AspNetCore, 1.0.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 SchemaRender.AspNetCore@1.0.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=SchemaRender.AspNetCore&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=SchemaRender.AspNetCore&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SchemaRender.NET

A developer-friendly ASP.NET Core library for adding Schema.org structured data (JSON-LD) to server-rendered pages.

Installation

Install the ASP.NET Core integration package (includes the core library):

dotnet add package SchemaRender.AspNetCore

Optionally, add the source generator for custom schema generation:

dotnet add package SchemaRender.Generator

Quick Start

1. Register Services

In your Program.cs:

builder.Services.AddSchemaRender();

2. Add Tag Helper

In _ViewImports.cshtml:

@addTagHelper *, SchemaRender.AspNetCore

3. Render in Layout

In _Layout.cshtml:

<head>
    
    <schema-render />
</head>

4. Add Schemas to Pages

public class RecipePage : SchemaPageModel
{
    public void OnGet()
    {
        Schema.Add(new RecipeSchema
        {
            Name = "Best Lasagna Ever",
            CookTime = TimeSpan.FromMinutes(45),
            PrepTime = TimeSpan.FromMinutes(30),
            RecipeIngredient = ["pasta", "ricotta", "mozzarella", "sauce"]
        });
    }
}

Usage Patterns

Using the Source Generator

Define schemas with attributes and let the generator create the implementation:

[SchemaType("Recipe")]
public partial class RecipeSchema
{
    public required string Name { get; init; }
    public TimeSpan? CookTime { get; init; }
    public TimeSpan? PrepTime { get; init; }

    [SchemaProperty(NestedType = "Person")]
    public string? Author { get; init; }

    public IReadOnlyList<string>? RecipeIngredient { get; init; }
}

The generator creates an optimized ISchema implementation automatically.

Hand-Written Schemas

Implement ISchema directly for full control:

public sealed class ArticleSchema : ISchema
{
    public required string Headline { get; init; }
    public DateTimeOffset? DatePublished { get; init; }

    public void Write(Utf8JsonWriter w)
    {
        w.WriteStartObject();
        w.WriteString("@context", "https://schema.org");
        w.WriteString("@type", "Article");
        w.WriteString("headline", Headline);

        if (DatePublished is not null)
            w.WriteString("datePublished", DatePublished.Value.ToString("O"));

        w.WriteEndObject();
    }
}

Dependency Injection

Inject ISchemaContext directly in pages or controllers:

public class ProductPage : PageModel
{
    public void OnGet([FromServices] ISchemaContext schema)
    {
        schema.Add(new ProductSchema { Name = "Widget" });
    }
}

HtmlHelper Extensions

Use Razor syntax with the HtmlHelper extension:

@inject ISchemaContext Schema

@{
    Schema.Add(new ArticleSchema
    {
        Headline = "My Post",
        DatePublished = DateTimeOffset.Now
    });
}

<head>
    @Html.RenderSchemas()
</head>

Built-in Schemas

The library includes ready-to-use implementations of the following schemas:

Schema	Description (see Schema.org)
`AggregateRatingSchema`	Aggregate ratings (e.g., for products)
`AnswerSchema`	Answers (for FAQ, Q&A)
`ArticleSchema`	Articles
`BlogPostingSchema`	Blog posts
`BreadcrumbListSchema`	Breadcrumb navigation lists
`EventSchema`	Events
`FAQPageSchema`	FAQ pages
`GeoCoordinatesSchema`	Geographic coordinates
`HowToSchema`	How-to guides
`HowToStepSchema`	Steps in a how-to guide
`ImageObjectSchema`	Images
`ListItemSchema`	Items in a list (e.g., breadcrumbs)
`LocalBusinessSchema`	Local businesses
`OfferSchema`	Offers (e.g., for products, events)
`OrganizationSchema`	Organizations
`PersonSchema`	People
`PostalAddressSchema`	Postal addresses
`ProductSchema`	Products
`QuestionSchema`	Questions (for FAQ, Q&A)
`RecipeSchema`	Recipes
`ReviewSchema`	Reviews
`VideoObjectSchema`	Videos
`WebSiteSchema`	Websites

Source Generator Attributes

`[SchemaType("TypeName")]`

Marks a partial class for schema generation:

[SchemaType("LocalBusiness")]
public partial class LocalBusinessSchema { }

`[SchemaProperty]`

Customizes property serialization:

[SchemaProperty(Name = "dateCreated", NestedType = "Person")]
public string? Author { get; init; }

`[SchemaIgnore]`

Excludes a property from the generated output:

[SchemaIgnore]
public string? InternalId { get; init; }

Supported Types

Category	Types
Primitives	`string`, `bool`, `int`, `double`, `decimal`
Dates	`DateTime`, `DateTimeOffset`, `DateOnly`, `TimeSpan`
Collections	`IReadOnlyList<T>`, `List<T>`, arrays
References	`Uri`, `ISchema` implementations

Special Property Handling

Address Properties

Properties like StreetAddress, AddressLocality, PostalCode, etc. are automatically nested as PostalAddress:

public string? StreetAddress { get; init; }
public string? AddressLocality { get; init; }
public string? PostalCode { get; init; }

Generates:

{
  "address": {
    "@type": "PostalAddress",
    "streetAddress": "123 Main St",
    "addressLocality": "New York",
    "postalCode": "10001"
  }
}

Geo Coordinates

Latitude and Longitude properties are automatically nested as GeoCoordinates:

public double? Latitude { get; init; }
public double? Longitude { get; init; }

Generates:

{
  "geo": {
    "@type": "GeoCoordinates",
    "latitude": 40.7128,
    "longitude": -74.0060
  }
}

Performance

SchemaRender is optimized for production use:

No reflection at runtime (source-generated code)
No intermediate strings or DOM manipulation
No JSON parsing or serialization round-trips
Direct streaming to response with Utf8JsonWriter
Zero allocations in hot paths

Architecture

Your Razor Page
  │
  │  Schema.Add(new RecipeSchema {...})
  ▼
ISchemaContext (Scoped per request)
  │
  │  Collects all schemas for the request
  ▼
<schema-render /> Tag Helper
  │
  │  SchemaRenderer.Render(context)
  ▼
Utf8JsonWriter
  │
  │  Direct byte[] → Response Stream
  ▼
<script type="application/ld+json">...</script>

Requirements

.NET 8.0 or later
ASP.NET Core 8.0 or later

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

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.

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	91	1/19/2026
1.0.0	90	1/17/2026