Pennington.DocSite.Api.ApiReferenceRegistrationOptions

namespace Pennington.DocSite.Api;

/// Per-registration options passed to AddApiReference.
public class ApiReferenceRegistrationOptions
{
    /// URL prefix under which this reference tree's pages are served. Leading and trailing slashes are normalized automatically. Examples: "/reference/api/", "/api/", "/api/spectre-cli/". Defaults to "/reference/api/".
    
public string RoutePrefix { get; set; } = "/reference/api/";

    /// Section label the TOC entry is grouped under in the sidebar. Leave null to keep the entry unsectioned. Set to a string that matches another page's sectionLabel to join that section.
    
public string? TocSectionLabel { get; set; }

    /// Sidebar title for the single TOC entry pointing at this registration's index page. Set to null to suppress the TOC entry entirely (the pages still publish). Defaults to "API reference".
    
public string? TocTitle { get; set; } = "API reference";
}