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 — قالب‌بندی یک سایت مستندات Mintlify با استفاده از توکن‌های Instructure.

toMintlifyConfig نگاشت هر IR را به کلیدهای colors + background از یک Mintlify 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 را مجدداً صادر می‌کند