Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

Syntax

Mintlify.Core.Models.AnchorConfig

Summary

Represents an anchor configuration in Mintlify navigation.

Remarks

Anchors provide navigation links in your documentation. The anchor name is required.

Constructors

.ctor

Syntax

public AnchorConfig()

Properties

Anchor

Gets or sets the name of the anchor.

Syntax

public string Anchor { get; set; }

Property Value

Type: string

Remarks

This is a required field that appears as the anchor label.

AsyncApi

Gets or sets the AsyncAPI configuration.

Syntax

public object AsyncApi { get; set; }

Property Value

Type: object?

Color

Gets or sets the color configuration for the anchor.

Syntax

public Mintlify.Core.Models.ColorPairConfig Color { get; set; }

Property Value

Type: Mintlify.Core.Models.ColorPairConfig? Gets or sets the dropdowns for the anchor.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig> Dropdowns { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig>?

Global

Gets or sets the global navigation configuration.

Syntax

public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; }

Property Value

Type: Mintlify.Core.Models.GlobalNavigationConfig?

Groups

Gets or sets the groups for the anchor.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig> Groups { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig>?

Hidden

Gets or sets whether the current option is default hidden.

Syntax

public System.Nullable<bool> Hidden { get; set; }

Property Value

Type: System.Nullable<bool>?

Href

Gets or sets the URL or path for the anchor.

Syntax

public string Href { get; set; }

Property Value

Type: string?

Icon

Gets or sets the icon to be displayed in the section.

Syntax

public object Icon { get; set; }

Property Value

Type: object?

Languages

Gets or sets the languages for the anchor.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig> Languages { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig>?

OpenApi

Gets or sets the OpenAPI configuration.

Syntax

public object OpenApi { get; set; }

Property Value

Type: object?

Pages

Gets or sets the pages for the anchor.

Syntax

public System.Collections.Generic.List<object> Pages { get; set; }

Property Value

Type: System.Collections.Generic.List<object>?

Tabs

Gets or sets the tabs for the anchor.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.TabConfig> Tabs { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.TabConfig>?

Versions

Gets or sets the versions for the anchor.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.VersionConfig> Versions { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.VersionConfig>?