This site provides a machine-readable index at /llms.txt.

Skip to main content Skip to navigation

ContentArea Pennington.DocSite

Defines a content area within a documentation site. Each area maps to a top-level directory and URL prefix, and gets its own TOC section.

Properties

Icon string?
Default: null
Optional SVG or markup for an icon beside the title.
Slug string
URL path prefix / top-level directory name (e.g., "getting-started").
Title string
Display name shown in the area selector (e.g., "Getting Started").

Constructors

.ctor

#
public record ContentArea(string Title, string Slug, string? Icon = null);

Defines a content area within a documentation site. Each area maps to a top-level directory and URL prefix, and gets its own TOC section.

Parameters

Title string
Display name shown in the area selector (e.g., "Getting Started").
Slug string
URL path prefix / top-level directory name (e.g., "getting-started").
Icon string? (optional)
Optional SVG or markup for an icon beside the title.

Pennington.DocSite.ContentArea

namespace Pennington.DocSite;

/// Defines a content area within a documentation site. Each area maps to a top-level directory and URL prefix, and gets its own TOC section.
public record ContentArea
{
    /// Defines a content area within a documentation site. Each area maps to a top-level directory and URL prefix, and gets its own TOC section.
    
public record ContentArea(string Title, string Slug, string? Icon = null);


    /// Optional SVG or markup for an icon beside the title.
    
string? Icon = null
;

    /// URL path prefix / top-level directory name (e.g., "getting-started").
    
string Slug
;

    /// Display name shown in the area selector (e.g., "Getting Started").
    
string Title
;
}