Skip to main content

​
Definition

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

​
Syntax

Mintlify.Core.Models.FontsConfig

​
Summary

Represents the font configuration for the Mintlify documentation site.

​
Remarks

This configuration allows customization of typography by specifying custom fonts including font family, weight, source URLs, and format specifications.

​
Constructors

​
.ctor

​
Syntax

public FontsConfig()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Family

Gets or sets the font family name.

​
Syntax

public string Family { get; set; }

​
Property Value

Type: string?

​
Remarks

Specifies the name of the font family to use, such as “Open Sans” or “Playfair Display”. This should match the font family name defined in the font file.

​
Format

Gets or sets the font file format.

​
Syntax

public string Format { get; set; }

​
Property Value

Type: string?

​
Remarks

Specifies the format of the font file. Valid values are “woff” or “woff2”. WOFF2 is preferred for modern browsers as it provides better compression.

​
Source

Gets or sets the font source URL.

​
Syntax

public string Source { get; set; }

​
Property Value

Type: string?

​
Remarks

Specifies the URL where the font file can be downloaded from. Should be a complete URL pointing to the font file, such as “https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2”.

​
Weight

Gets or sets the font weight.

​
Syntax

public System.Nullable<int> Weight { get; set; }

​
Property Value

Type: System.Nullable<int>?

​
Remarks

Specifies the font weight as a numeric value such as 400 (normal) or 700 (bold). Precise font weights like 550 are supported for variable fonts. Common values include 300 (light), 400 (normal), 500 (medium), 600 (semi-bold), 700 (bold).

​
Methods

​
Equals Inherited Virtual

Inherited from object

​
Syntax

public virtual bool Equals(object obj)

​
Parameters

NameTypeDescription
objobject?-

​
Returns

Type: bool

​
Equals Inherited

Inherited from object

​
Syntax

public static bool Equals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
GetHashCode Inherited Virtual

Inherited from object

​
Syntax

public virtual int GetHashCode()

​
Returns

Type: int

​
GetType Inherited

Inherited from object

​
Syntax

public System.Type GetType()

​
Returns

Type: System.Type

​
MemberwiseClone Inherited

Inherited from object

​
Syntax

protected internal object MemberwiseClone()

​
Returns

Type: object

​
ReferenceEquals Inherited

Inherited from object

​
Syntax

public static bool ReferenceEquals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?