IFrontMatter Pennington.FrontMatter

Minimum: every content page has a title. Default members provide sensible opt-out values so implementations only declare properties they actually parse from front matter.

Properties

Date System.DateTime?: Default: null
Publication or last-modified date surfaced in feeds and sitemaps.
Description string?: Default: null
Short summary used in meta descriptions, OpenGraph tags, and listings.
IsDraft bool: Default: false
True when the page is a draft and should be excluded from builds.
Llms bool: Default: true
True when the page should be included in llms.txt output.
Search bool: Default: true
True when the page should be included in the search index.
Title string: Page title rendered in the browser tab, navigation, and OpenGraph tags.
Uid string?: Default: null
Stable cross-reference identifier used by xref links.

Pennington.FrontMatter.IFrontMatter

namespace Pennington.FrontMatter;

/// Minimum: every content page has a title. Default members provide sensible opt-out values so implementations only declare properties they actually parse from front matter.
public interface IFrontMatter
{
    /// Publication or last-modified date surfaced in feeds and sitemaps.
    DateTime? Date => null;

    /// Short summary used in meta descriptions, OpenGraph tags, and listings.
    string? Description => null;

    /// True when the page is a draft and should be excluded from builds.
    bool IsDraft => false;

    /// True when the page should be included in llms.txt output.
    bool Llms => true;

    /// True when the page should be included in the search index.
    bool Search => true;

    /// Page title rendered in the browser tab, navigation, and OpenGraph tags.
    string Title { get; }

    /// Stable cross-reference identifier used by xref links.
    string? Uid => null;
}