RenderedContent Pennington.Pipeline

Output produced by the render stage for a single content item.

Properties

CrossReferences System.Collections.Immutable.ImmutableList<Pennington.Pipeline.CrossReference>: Cross-reference targets defined by the content.
Html string: Rendered HTML body.
Outline Pennington.Pipeline.OutlineEntry[]: Heading outline extracted from the content.
SearchDocument Pennington.Search.SearchIndexDocument?: Default: null
Optional search index document for this page.
Social Pennington.Pipeline.SocialMetadata?: Default: null
Optional social/Open Graph metadata for this page.
Tags System.Collections.Immutable.ImmutableList<Pennington.Pipeline.Tag>: Tags associated with the content.

Constructors

.ctor

public record RenderedContent(
    string Html,
    OutlineEntry[] Outline,
    ImmutableList<Tag> Tags,
    ImmutableList<CrossReference> CrossReferences,
    SearchIndexDocument? SearchDocument,
    SocialMetadata? Social
);

Output produced by the render stage for a single content item.

Parameters

Html string: Rendered HTML body.
Outline OutlineEntry[]: Heading outline extracted from the content.
Tags ImmutableList<Tag>: Tags associated with the content.
CrossReferences ImmutableList<CrossReference>: Cross-reference targets defined by the content.
SearchDocument SearchIndexDocument?: Optional search index document for this page.
Social SocialMetadata?: Optional social/Open Graph metadata for this page.

Pennington.Pipeline.RenderedContent

namespace Pennington.Pipeline;

/// Output produced by the render stage for a single content item.
public record RenderedContent
{
    /// Output produced by the render stage for a single content item.
    public record RenderedContent(
    string Html,
    OutlineEntry[] Outline,
    ImmutableList<Tag> Tags,
    ImmutableList<CrossReference> CrossReferences,
    SearchIndexDocument? SearchDocument,
    SocialMetadata? Social
);

    /// Cross-reference targets defined by the content.
    ImmutableList<CrossReference> CrossReferences;

    /// Rendered HTML body.
    string Html;

    /// Heading outline extracted from the content.
    OutlineEntry[] Outline;

    /// Optional search index document for this page.
    SearchIndexDocument? SearchDocument;

    /// Optional social/Open Graph metadata for this page.
    SocialMetadata? Social;

    /// Tags associated with the content.
    ImmutableList<Tag> Tags;
}