AdmonitionBlock

Home
API Reference
Moka
Docs
Parsing
Markdown
AdmonitionBlock

Class Sealed

public sealed class AdmonitionBlock : ContainerBlock

Namespace: Moka.Docs.Parsing.Markdown

Represents an admonition block in the AST.

Inheritance

Inherits from: ContainerBlock

Constructors

Name	Description
`AdmonitionBlock(BlockParser parser)`	Creates a new admonition block.

AdmonitionBlock(BlockParser parser)

AdmonitionBlock.AdmonitionBlock(BlockParser parser)

Creates a new admonition block.

Properties

Name	Description
`AdmonitionType`	The admonition type (note, tip, warning, danger, info).
`Title`	Optional custom title. If null, uses the type name as title.

AdmonitionType

string AdmonitionBlock.AdmonitionType { get; set; }

The admonition type (note, tip, warning, danger, info).

Title

string? AdmonitionBlock.Title { get; set; }

Optional custom title. If null, uses the type name as title.

Type Relationships

classDiagram
                    style AdmonitionBlock fill:#f9f,stroke:#333,stroke-width:2px
                    AdmonitionBlock --|> ContainerBlock : inherits

View Source

/// <summary>
///     Represents an admonition block in the AST.
/// </summary>
public sealed class AdmonitionBlock : ContainerBlock
{
    /// <summary>Creates a new admonition block.</summary>
    public AdmonitionBlock(BlockParser parser) : base(parser)
    {
    }

    /// <summary>The admonition type (note, tip, warning, danger, info).</summary>
    public string AdmonitionType { get; set; } = "note";
    /// <summary>Optional custom title. If null, uses the type name as title.</summary>
    public string? Title { get; set; }
}