Skip to content

pantoken-root / 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

Experimental

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

toMintlifyConfig maps any IR onto the colors + background keys of a Mintlify docs.json; docsJson 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 ​

Variables ​

Functions ​

References ​

default ​

Renames and re-exports docsJson