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.1614. Newer releases require review.

Full compatibility matrix

实验性

@pantoken/mintlify — 使用 Instructure 令牌为 Mintlify 文档站点设置主题。

toMintlifyConfig 将任何 IR 映射到 Mintlify 的 colors + background 键的 docs.json;docsJson 是现成的 rebrand 片段。将其合并到你的 docs.json。

示例 ​

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

接口 ​

变量 ​

函数 ​

引用 ​

default ​

重命名并重新导出 docsJson