EditLinkConfig

Home
API Reference
Moka
Docs
Core
Configuration
EditLinkConfig

Record

public record EditLinkConfig : System.IEquatable<Moka.Docs.Core.Configuration.EditLinkConfig>

Namespace: Moka.Docs.Core.Configuration

Configuration for "Edit this page" links pointing to a source repository.

Inheritance

Implements: System.IEquatable<Moka.Docs.Core.Configuration.EditLinkConfig>

Properties

Name	Description
`Branch`	Branch name (defaults to "main").
`Path`	Path prefix within the repo where docs live.
`Repo`	Repository URL (e.g., "https://github.com/org/repo").

Branch

string EditLinkConfig.Branch { get; init; }

Branch name (defaults to "main").

Path

string EditLinkConfig.Path { get; init; }

Path prefix within the repo where docs live.

Repo

string EditLinkConfig.Repo { get; init; }

Repository URL (e.g., "https://github.com/org/repo").

Type Relationships

classDiagram
                    style EditLinkConfig fill:#f9f,stroke:#333,stroke-width:2px
                    EditLinkConfig ..|> EditLinkConfig~ : implements

View Source

/// <summary>
///     Configuration for "Edit this page" links pointing to a source repository.
/// </summary>
public sealed record EditLinkConfig
{
    /// <summary>Repository URL (e.g., "https://github.com/org/repo").</summary>
    public required string Repo { get; init; }
    /// <summary>Branch name (defaults to "main").</summary>
    public string Branch { get; init; } = "main";
    /// <summary>Path prefix within the repo where docs live.</summary>
    public string Path { get; init; } = "docs/";
}