GlobalAnchorConfig

Represents an anchor configuration for global navigation in the Mintlify documentation site.

Syntax

public class GlobalAnchorConfig

Inheritance

Properties

Anchor

[JsonPropertyName("anchor")]
public string Anchor { get; set; }
Gets or sets the display name for the anchor link.

Returns

string

Color

[JsonPropertyName("color")]
public ColorPairConfig Color { get; set; }
Gets or sets the color configuration for the anchor.

Returns

ColorPairConfig

Hidden

[JsonPropertyName("hidden")]
public bool? Hidden { get; set; }
Gets or sets whether this anchor is hidden by default.

Returns

bool?

Href

[JsonPropertyName("href")]
public string Href { get; set; }
Gets or sets the URL or path for this anchor link.

Returns

string

Icon

[JsonPropertyName("icon")]
public object Icon { get; set; }
Gets or sets the icon to display alongside the anchor name.

Returns

object

Remarks

This configuration defines an anchor link that appears globally across all sections and pages, providing users with quick access to important external resources or key pages.