Skip to content

API ​

pantoken 是一个由按功能分组的小型单一职责包组成的 monorepo。安装适合你任务的包,或安装统一的 pantoken 包并从其子路径导入(例如 pantoken/css, pantoken/react, pantoken/tailwind)。

Core ​

将 tokens 转换为文件格式。

PackageWhat it does
@pantoken/modelZero-dependency TypeScript types: the Token shape and the plugin contract.
@pantoken/coreResolves the upstream tokens and icons into the canonical IR, and renders CSS.
@pantoken/tokensThe resolved IR vendored as static JSON, per theme, plus the raw Tokens Studio source.
@pantoken/utilsThe token resolver, reference regexes, case and color helpers, drift checks, and the token→utility-class emitters.
@pantoken/plugin-kitBuild and compose pantoken plugins with definePlugin.
@pantoken/clipantoken generate <target> — emit native and platform source.

Formats ​

由 CLI 或其自身 API 发出的原生与站点生成器目标。

PackageOutput
@pantoken/css@property-typed CSS with light-dark() and data-URI icons.
@pantoken/scssSCSS variables, resolved to a single mode.
@pantoken/lessLess variables.
@pantoken/stylusStylus variables.
@pantoken/dtcgA W3C Design Tokens (DTCG) document.
@pantoken/tokensThe IR as JavaScript and JSON (also listed under Core).
@pantoken/iconsAn ergonomic view over the icon tokens.
@pantoken/icon-fontAn icon web font (TTF, WOFF2) plus its CSS.
@pantoken/componentsAn InstUI-look CSS component library (button, alert, table, and more) plus a base reset with focus ring, prose styling, cross-cutting utilities, and the brand fonts. See Components.
@pantoken/inline-stylesGeneric CSS-to-HTML inlining for platform integrations.

Renderers ​

扩展 token 或 CSS 输出的可选转换。参见 Plugins。

PackageFor
@pantoken/reactReact hooks, <Icon>, and a token provider.
@pantoken/vue, @pantoken/svelte, @pantoken/angularThe web component, wired into each framework.
@pantoken/react-nativeStyleSheet-friendly token objects (no CSS variables).
@pantoken/web-components<instui-icon> and styled primitives, framework-agnostic.
@pantoken/astroToken setup for Astro sites.
@pantoken/react-markdown, @pantoken/rehypeIcon tokens and swatches in Markdown.
@pantoken/markdown-itA markdown-it plugin for icon codes and color swatches.
@pantoken/css-in-jsA type-safe theme for styled-components and Emotion.
@pantoken/muiA Material UI theme.
@pantoken/bootstrap, @pantoken/shadcnCSS-variable bridges for Bootstrap and shadcn/ui.
@pantoken/foundationA Sass settings override and CSS overlay for Foundation.
@pantoken/docusaurus, @pantoken/vitepressThemes for Docusaurus and VitePress.
@pantoken/mintlifyA Mintlify docs.json theme (colors + background).
@pantoken/storybookA Storybook theme.
@pantoken/pendoInstructure-styled global CSS for Pendo guides.

Bundlers ​

BuildIconFontOptions

PackageFor
@pantoken/viteA Vite plugin with virtual modules and CSS injection.
@pantoken/nextwithPantoken for Next.js transpilePackages.
@pantoken/webpackA webpack plugin.
@pantoken/postcssThe @pantoken; at-rule.
@pantoken/tailwindA Tailwind preset.
@pantoken/pandaA Panda CSS preset.

Platforms ​

@pantoken/validate-generated 是一个一次性运行脚本(由 pnpm run ready 调用),所以它没有 API 页面;其他的都有。

PackageOutput
@pantoken/swiftSwift source plus a SwiftPM manifest stub.
@pantoken/androidAndroid XML resources.
@pantoken/composeJetpack Compose Kotlin.
@pantoken/flutterFlutter Dart.
@pantoken/rustRust consts for egui or iced.
@pantoken/wordpressA WordPress block-theme theme.json.
@pantoken/vanillaA Vanilla Forums variables.json.
@pantoken/drupalDrupal theme assets.
@pantoken/hugo, @pantoken/jekyllHugo and Jekyll site data.
@pantoken/emailInline-friendly values for HTML email.

Design ​

面向消费者的 AI 设置资产。这些用于使用 pantoken 的项目,而不是用于开发 pantoken 本身。

PackageOutput
@pantoken/figmaA Figma Variables payload.
@pantoken/swatchesColor swatches (ASE, GPL, Sketch) plus a viewable SVG specimen sheet.

Plugins ​

  • @pantoken/ai 安装 AGENTS.md, llms.txt,以及助理/编辑器规则(Cursor、Copilot、Windsurf、Claude Code)到消费者仓库中。
PackageWhat it adds
@pantoken/plugin-stackingNamed z-index depths as --instui-stacking-* tokens.
@pantoken/plugin-visual-debugThe -with-visual-debug layout-debugging outline.
@pantoken/plugin-simple-iconsBrand icons from simple-icons.
@pantoken/plugin-logosInstructure product logos as SVGs, data URIs, and image tokens.
@pantoken/plugin-prune-custom-propsA PostCSS plugin that drops unused custom properties.

Tools ​

为 monorepo 本身构建、文档和演示基础设施。大部分是内部使用,但这些组件是 自包含的,因此我们在此记录它们,其中一些单独发布到 npm。

PackageWhat it does
@pantoken/aggregateGenerates the unified pantoken package barrel and exports from its dependencies.
@pantoken/validate-generatedThe drift gate: checks every generated stylesheet resolves against the token IR.
@pantoken/demoThe self-hosted live-demo runner: resolves a @demo spec to an iframe and renders bare HTML/CSS/JS same-origin, token-themed.
@cssdoc/core (external)A generic CSS documentation extractor (TSDoc, for CSS): parses doc-comments + the CSS AST into a model the docs emit as the CSS API reference. Lives in its own repo; consumed via a link dependency.

@pantoken/validate-generated 是一个只运行一次的脚本(由 pnpm run ready) 调用,因此它没有 API 页面;其他的有。

AI ​

@pantoken/ai — 面向使用 pantoken 的项目的消费者端代理资产(不是用于 开发 pantoken 本身)。

  • @pantoken/ai 安装 AGENTS.md, llms.txt,并 assistant/editor 规则(Cursor, Copilot, Windsurf, Claude Code))到消费者仓库。

Dev plugins ​

我们为所使用的构建工具编写的插件,按宿主分组。它们是独立的且可发布的。

PackagePlugs into
@pantoken/typedoc-plugin-demoTypeDoc: turns a @demo <provider>:<ref> block tag into an embeddable demo fence.
@pantoken/vite-workspace-orchestratorVite: rebuilds upstream workspace packages (and dependents) when their source changes.