Record
public record MarkdownParseResult : System.IEquatable<Moka.Docs.Parsing.Markdown.MarkdownParseResult>

Namespace: Moka.Docs.Parsing.Markdown

The result of parsing a Markdown file.

Inheritance

Implements: System.IEquatable<Moka.Docs.Parsing.Markdown.MarkdownParseResult>

Properties

NameDescription
FrontMatter The parsed front matter metadata.
Html The rendered HTML content.
PlainText The plain text content (for search indexing).
TableOfContents The auto-generated table of contents.

FrontMatter

FrontMatter MarkdownParseResult.FrontMatter { get; init; }

The parsed front matter metadata.

Html

string MarkdownParseResult.Html { get; init; }

The rendered HTML content.

PlainText

string MarkdownParseResult.PlainText { get; init; }

The plain text content (for search indexing).

TableOfContents

TableOfContents MarkdownParseResult.TableOfContents { get; init; }

The auto-generated table of contents.

Type Relationships
classDiagram
                    style MarkdownParseResult fill:#f9f,stroke:#333,stroke-width:2px
                    MarkdownParseResult ..|> MarkdownParseResult~ : implements
                
View Source
/// <summary>
///     The result of parsing a Markdown file.
/// </summary>
public sealed record MarkdownParseResult
{
    /// <summary>The parsed front matter metadata.</summary>
    public required Core.Content.FrontMatter FrontMatter { get; init; }
    /// <summary>The rendered HTML content.</summary>
    public required string Html { get; init; }
    /// <summary>The plain text content (for search indexing).</summary>
    public required string PlainText { get; init; }
    /// <summary>The auto-generated table of contents.</summary>
    public required TableOfContents TableOfContents { get; init; }
}
Was this page helpful?