> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stinwo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Global Settings

> Mintlify gives you complete control over the look and feel of your documentation using the docs.json file

Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below.

## Properties

**name** `string` *required*

Name of your project. Used for the global title.

Example: `mintlify`

**navigation** `Navigation[]` *required*

An array of groups with all the pages within that group

**Navigation**

**group** `string`

The name of the group.

Example: `Settings`

**pages** `string[]`

The relative paths to the markdown files that will serve as pages.

Example: `["customization", "page"]`

**logo** `string or object`

Path to logo image or object with path to "light" and "dark" mode logo images

**Logo**

**light** `string`

Path to the logo in light mode

**dark** `string`

Path to the logo in dark mode

**href** `string` (default: /)

Where clicking on the logo links you to

**favicon** `string`

Path to the favicon image

**colors** `Colors`

Hex color codes for your global theme

**Colors**

**primary** `string` *required*

The primary color. Used for most often for highlighted content, section
headers, accents, in light mode

**light** `string`

The primary color for dark mode. Used for most often for highlighted
content, section headers, accents, in dark mode

**dark** `string`

The primary color for important buttons

**background** `object`

The color of the background in both light and dark mode

**Object**

**light** `string` *required*

The hex color code of the background in light mode

**dark** `string` *required*

The hex color code of the background in dark mode

**topbarLinks** `TopbarLink[]`

Array of `name`s and `url`s of links you want to include in the topbar

**TopbarLink**

**name** `string`

The name of the button.

Example: `Contact us`

**url** `string`

The url once you click on the button. Example: `https://mintlify.com/docs`

**topbarCtaButton** `Call to Action`

**Topbar Call to Action**

**type** `"link" or "github"` (default: link)

Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.

**url** `string`

If `link`: What the button links to.

If `github`: Link to the repository to load GitHub information from.

**name** `string`

Text inside the button. Only required if `type` is a `link`.

**versions** `string[]`

Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.

**anchors** `Anchor[]`

An array of the anchors, includes the `icon`, `color`, and `url`.

**Anchor**

**icon** `string`

The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor.

Example: `comments`

**name** `string`

The name of the anchor label.

Example: `Community`

**url** `string`

The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.

**color** `string`

The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color.

**version** `string`

Used if you want to hide an anchor until the correct docs version is selected.

**isDefaultHidden** `boolean` (default: false)

Pass `true` if you want to hide the anchor until you directly link someone to docs inside it.

**iconType** `string` (default: duotone)

One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"

**topAnchor** `Object`

Override the default configurations for the top-most anchor.

**Object**

**name** `string` (default: Documentation)

The name of the top-most anchor

**icon** `string` (default: book-open)

Font Awesome icon.

**iconType** `string` (default: duotone)

One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"

**tabs** `Tabs[]`

An array of navigational tabs.

**Tabs**

**name** `string`

The name of the tab label.

**url** `string`

The start of the URL that marks what pages go in the tab. Generally, this
is the name of the folder you put your pages in.

**api** `API`

Configuration for API settings. Learn more about API pages at [API Components](https://docs.stinwo.com/api-playground/demo).

**API**

**baseUrl** `string`

The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url
options that the user can toggle.

**auth** `Auth`

**Auth**

**method** `"bearer" | "basic" | "key"`

The authentication strategy used for all API endpoints.

**name** `string`

The name of the authentication parameter used in the API playground.

If method is `basic`, the format should be `[usernameName]:[passwordName]`

**inputPrefix** `string`

The default value that's designed to be a prefix for the authentication input field.

E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`.

**playground** `Playground`

Configurations for the API playground

**Playground**

**mode** `"show" | "simple" | "hide"` (default: show)

Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple`

Learn more at the [playground guides](https://docs.stinwo.com/api-playground/demo)

**maintainOrder** `boolean`

Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.

> [!WARNING]
>
> This behavior will soon be enabled by default, at which point this field will be deprecated.

**openapi** `string | string[]`

A string or an array of strings of URL(s) or relative path(s) pointing to your
OpenAPI file.

Examples:

```json Absolute theme={null}
"openapi": "https://example.com/openapi.json"
```

```json Relative theme={null}
"openapi": "/openapi.json"
```

```json Multiple theme={null}
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
```

**footerSocials** `FooterSocials`

An object of social media accounts where the key:property pair represents the social media platform and the account url.

Example:

```json theme={null}
{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}
```

**FooterSocials**

**\[key]** `string`

One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`

Example: `x`

**property** `string`

The URL to the social platform.

Example: `https://x.com/mintlify`

**feedback** `Feedback`

Configurations to enable feedback buttons

**Feedback**

**suggestEdit** `boolean` (default: false)

Enables a button to allow users to suggest edits via pull requests

**raiseIssue** `boolean` (default: false)

Enables a button to allow users to raise an issue about the documentation

**modeToggle** `ModeToggle`

Customize the dark mode toggle.

**ModeToggle**

**default** `"light" or "dark"`

Set if you always want to show light or dark mode for new users. When not
set, we default to the same mode as the user's operating system.

**isHidden** `boolean` (default: false)

Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:

```json Only Dark Mode theme={null}
"modeToggle": {
  "default": "dark",
  "isHidden": true
}
```

```json Only Light Mode theme={null}
"modeToggle": {
  "default": "light",
  "isHidden": true
}
```

**backgroundImage** `string`

A background image to be displayed behind every page. See example with
[Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.