---
url: /api/renderers/mintlify/src.md
---
[pantoken-root](../../../index.md) / mintlify

# mintlify

## Compatibility

Target: Mintlify docs.json. Current format: `Official CLI validates generated colors and background theme config`. Minimum host version: `4.0.1555`. Tested through `4.0.1591`. Newer releases require review.

[Full compatibility matrix](../../../../compatibility)

Experimental

`@pantoken/mintlify` — theme a Mintlify docs site with Instructure tokens.

[toMintlifyConfig](functions/toMintlifyConfig.md) maps any IR onto the `colors` + `background` keys of a Mintlify
`docs.json`; [docsJson](variables/docsJson.md) is the ready-made `rebrand` fragment. Merge it into your `docs.json`.

## Example

```jsonc
// docs.json
{
  "name": "My docs",
  "theme": "mint",
  "colors": { "primary": "#1D354F", "light": "#EEF4FD", "dark": "#1D354F" },
  "background": { "color": { "light": "#F2F4F5", "dark": "#10141A" } }
}
```

## Interfaces

* [MintlifyColors](interfaces/MintlifyColors.md)
* [MintlifyBackground](interfaces/MintlifyBackground.md)
* [MintlifyTheme](interfaces/MintlifyTheme.md)

## Variables

* [docsJson](variables/docsJson.md)

## Functions

* [toMintlifyConfig](functions/toMintlifyConfig.md)

## References

### default

Renames and re-exports [docsJson](variables/docsJson.md)