GlobalSiteConfig

Represents the global settings for the entire documentation site.

Syntax

public class GlobalSiteConfig

Inheritance

Properties

Colors

[JsonPropertyName("colors")]
public ColorsConfig Colors { get; set; }
Gets or sets the color scheme for the site.

Returns

ColorsConfig The primary colors used throughout the site interface.

Favicon

[JsonPropertyName("favicon")]
public string Favicon { get; set; }
Gets or sets the favicon path for the site.

Returns

string The relative path to the site’s favicon file.
[JsonPropertyName("footer")]
public FooterConfig Footer { get; set; }
Gets or sets the footer configuration for the site.

Returns

FooterConfig The footer content including social media links.
[JsonPropertyName("logo")]
public LogoConfig Logo { get; set; }
Gets or sets the logo configuration for the site.

Returns

LogoConfig The logo images used in light and dark themes.

OutputFolder

[JsonPropertyName("outputFolder")]
public string OutputFolder { get; set; }
Gets or sets the output folder for the generated documentation.

Returns

string The directory where the combined documentation will be generated.

SiteName

[JsonPropertyName("siteName")]
public string SiteName { get; set; }
Gets or sets the name of the documentation site.

Returns

string The site title displayed in the browser and navigation.

Theme

[JsonPropertyName("theme")]
public string Theme { get; set; }
Gets or sets the theme name for the site.

Returns

string The Mintlify theme to use for the site appearance.

Remarks

This class contains site-wide configuration that applies across all solutions and defines the overall appearance and behavior of the documentation site.