IBuildPhase

Home
API Reference
Moka
Docs
Core
Pipeline
IBuildPhase

Interface

public interface IBuildPhase

Namespace: Moka.Docs.Core.Pipeline

A single phase in the MokaDocs build pipeline.

Properties

Name	Description
`Name` abstract	Display name of this phase.
`Order` abstract	Execution order (lower runs first).

Name

string IBuildPhase.Name { get; }

Display name of this phase.

Order

int IBuildPhase.Order { get; }

Execution order (lower runs first).

Methods

Name	Description
`ExecuteAsync(BuildContext context, CancellationToken ct)` abstract	Execute this build phase.

ExecuteAsync(BuildContext context, CancellationToken ct)

Task IBuildPhase.ExecuteAsync(BuildContext context, CancellationToken ct = null)

Execute this build phase.

Type Relationships

classDiagram
                    style IBuildPhase fill:#f9f,stroke:#333,stroke-width:2px
                    CSharpAnalysisPhase --|> IBuildPhase : inherits
                    DiscoveryPhase --|> IBuildPhase : inherits
                    FeatureGatePhase --|> IBuildPhase : inherits
                    MarkdownParsePhase --|> IBuildPhase : inherits
                    NavigationBuildPhase --|> IBuildPhase : inherits
                    OutputPhase --|> IBuildPhase : inherits
                    PostProcessPhase --|> IBuildPhase : inherits
                    RenderPhase --|> IBuildPhase : inherits
                    SearchIndexPhase --|> IBuildPhase : inherits
                    ThemeAssetPhase --|> IBuildPhase : inherits

View Source

/// <summary>
///     A single phase in the MokaDocs build pipeline.
/// </summary>
public interface IBuildPhase
{
    /// <summary>Display name of this phase.</summary>
    string Name { get; }

    /// <summary>Execution order (lower runs first).</summary>
    int Order { get; }

    /// <summary>Execute this build phase.</summary>
    Task ExecuteAsync(BuildContext context, CancellationToken ct = default);
}