Record
public record SiteMetadata : System.IEquatable<Moka.Docs.Core.Configuration.SiteMetadata>
Namespace: Moka.Docs.Core.Configuration
Site metadata: title, description, base URL, branding.
Inheritance
Implements: System.IEquatable<Moka.Docs.Core.Configuration.SiteMetadata>
Properties
| Name | Description |
|---|---|
Copyright |
Copyright notice for the footer. |
Description |
A short description of the site for meta tags. |
EditLink |
Edit link configuration for "Edit this page" links. |
Favicon |
Resolved reference to the site favicon. Same resolution rules as SiteMetadata.Logo. |
Logo |
Resolved reference to the site logo. See SiteAssetReference for the supported yaml forms (relative to mokadocs.yaml dir, parent-dir escape with ../, absolute URL pass-through). |
Title |
The site title displayed in the header and browser tab. |
Url |
The base URL where the site will be hosted. |
Copyright
string? SiteMetadata.Copyright { get; init; }
Copyright notice for the footer.
Description
string SiteMetadata.Description { get; init; }
A short description of the site for meta tags.
EditLink
EditLinkConfig? SiteMetadata.EditLink { get; init; }
Edit link configuration for "Edit this page" links.
Favicon
SiteAssetReference? SiteMetadata.Favicon { get; init; }
Resolved reference to the site favicon. Same resolution rules as SiteMetadata.Logo.
Logo
SiteAssetReference? SiteMetadata.Logo { get; init; }
Resolved reference to the site logo. See SiteAssetReference for the supported yaml forms (relative to mokadocs.yaml dir, parent-dir escape with ../, absolute URL pass-through).
Title
string SiteMetadata.Title { get; init; }
The site title displayed in the header and browser tab.
Url
string SiteMetadata.Url { get; init; }
The base URL where the site will be hosted.
Type Relationships
classDiagram
style SiteMetadata fill:#f9f,stroke:#333,stroke-width:2px
SiteMetadata ..|> SiteMetadata~ : implements
View Source
/// <summary>
/// Site metadata: title, description, base URL, branding.
/// </summary>
public sealed record SiteMetadata
{
/// <summary>The site title displayed in the header and browser tab.</summary>
public required string Title { get; init; }
/// <summary>A short description of the site for meta tags.</summary>
public string Description { get; init; } = "";
/// <summary>The base URL where the site will be hosted.</summary>
public string Url { get; init; } = "";
/// <summary>
/// Resolved reference to the site logo. See <see cref = "SiteAssetReference"/> for
/// the supported yaml forms (relative to mokadocs.yaml dir, parent-dir escape with
/// <c>../</c>, absolute URL pass-through).
/// </summary>
public SiteAssetReference? Logo { get; init; }
/// <summary>
/// Resolved reference to the site favicon. Same resolution rules as <see cref = "Logo"/>.
/// </summary>
public SiteAssetReference? Favicon { get; init; }
/// <summary>Copyright notice for the footer.</summary>
public string? Copyright { get; init; }
/// <summary>Edit link configuration for "Edit this page" links.</summary>
public EditLinkConfig? EditLink { get; init; }
}