This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy under /_llms/. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Skip to main content Skip to navigation

SocialCardRequest Pennington.SocialCards

Everything Render needs to draw a card for one page: the page's resolved metadata plus the site identity and the card's own absolute URL.

Properties

CanonicalPath UrlPath
Canonical path of the page the card represents.
CardUrl string
The card's own URL — absolute when a canonical base URL is configured, else root-relative.
Date DateTime?
Publication date, when set.
Description string
Page description, when the front matter supplies one.
Height int
Requested card height in pixels.
Locale string
Locale code of the page, or null for the default locale.
Metadata IFrontMatter
The page's full typed front matter, so a renderer can read tags, author, and other capabilities.
SiteDescription string
Site description, available for fallback copy.
SiteTitle string
Site title, for branding the card.
Title string
Page title.
Width int
Requested card width in pixels.

Constructors

SocialCardRequest

#
public SocialCardRequest(string Title, string Description, DateTime? Date, UrlPath CanonicalPath, string CardUrl, string Locale, string SiteTitle, string SiteDescription, IFrontMatter Metadata, int Width, int Height)

Everything Render needs to draw a card for one page: the page's resolved metadata plus the site identity and the card's own absolute URL.

Parameters

Title string
Page title.
Description string
Page description, when the front matter supplies one.
Date DateTime?
Publication date, when set.
CanonicalPath UrlPath
Canonical path of the page the card represents.
CardUrl string
The card's own URL — absolute when a canonical base URL is configured, else root-relative.
Locale string
Locale code of the page, or null for the default locale.
SiteTitle string
Site title, for branding the card.
SiteDescription string
Site description, available for fallback copy.
Metadata IFrontMatter
The page's full typed front matter, so a renderer can read tags, author, and other capabilities.
Width int
Requested card width in pixels.
Height int
Requested card height in pixels.

Pennington.SocialCards.SocialCardRequest

namespace Pennington.SocialCards;

/// Everything Render needs to draw a card for one page: the page's resolved metadata plus the site identity and the card's own absolute URL.
public record SocialCardRequest
{
    /// Canonical path of the page the card represents.
    
public UrlPath CanonicalPath { get; set; }
/// The card's own URL — absolute when a canonical base URL is configured, else root-relative.
public string CardUrl { get; set; }
/// Publication date, when set.
public DateTime? Date { get; set; }
/// Page description, when the front matter supplies one.
public string Description { get; set; }
/// Requested card height in pixels.
public int Height { get; set; }
/// Locale code of the page, or null for the default locale.
public string Locale { get; set; }
/// The page's full typed front matter, so a renderer can read tags, author, and other capabilities.
public IFrontMatter Metadata { get; set; }
/// Site description, available for fallback copy.
public string SiteDescription { get; set; }
/// Site title, for branding the card.
public string SiteTitle { get; set; }
/// Everything Render needs to draw a card for one page: the page's resolved metadata plus the site identity and the card's own absolute URL.
public SocialCardRequest(string Title, string Description, DateTime? Date, UrlPath CanonicalPath, string CardUrl, string Locale, string SiteTitle, string SiteDescription, IFrontMatter Metadata, int Width, int Height)
; /// Page title.
public string Title { get; set; }
/// Requested card width in pixels.
public int Width { get; set; }
}