Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents an anchor configuration for global navigation in the Mintlify documentation site.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.Constructors
.ctor
Syntax
Properties
Anchor
Gets or sets the display name for the anchor link.Syntax
Property Value
Type:string
Remarks
Specifies the text that will be shown for the anchor link. Should be concise and descriptive of the link’s destination, such as “GitHub”, “API Status”, “Support”, etc. This is a required field.Color
Gets or sets the color configuration for the anchor.Syntax
Property Value
Type:Mintlify.Core.Models.ColorPairConfig?
Remarks
Defines custom colors for the anchor link in light and dark modes. This allows the anchor to have distinctive styling that matches your brand or indicates different types of external resources.Hidden
Gets or sets whether this anchor is hidden by default.Syntax
Property Value
Type:System.Nullable<bool>?
Remarks
When true, this anchor will not be visible in the global navigation unless specifically shown. This can be useful for anchors that are temporary or not ready for public access.Href
Gets or sets the URL or path for this anchor link.Syntax
Property Value
Type:string?
Remarks
Specifies where users should be directed when they click on this anchor. Can be a relative path within the documentation or an absolute URL for external resources such as GitHub repositories, status pages, or support portals.Icon
Gets or sets the icon to display alongside the anchor name.Syntax
Property Value
Type:object?