An open source design system that's fully customizable and agent ready
TypeScript
docs: use dist build for StyleX and Vite setup guides (#1618)
Cindy Zhang7934fb55720e
diff --git a/packages/core/README.md b/packages/core/README.mdindex bf7e0f0e37..7cdcc1c036 100644--- a/packages/core/README.md+++ b/packages/core/README.md@@ -49,7 +49,6 @@ npx xds gap-report # report a missing capability| Package | Description ||---------|-------------|| [`@xds/cli`](https://github.com/facebookexperimental/xds/tree/main/packages/cli) | CLI tooling — component docs, templates, scaffolding, codemods |-| [`@xds/build`](https://github.com/facebookexperimental/xds/tree/main/packages/build) | Build plugins for StyleX source builds (Babel, PostCSS, Vite) || [`@xds/theme-default`](https://github.com/facebookexperimental/xds/tree/main/packages/themes/default) | Default theme (Heroicons) || [`@xds/theme-neutral`](https://github.com/facebookexperimental/xds/tree/main/packages/themes/neutral) | Muted, minimal theme (Lucide icons) || [`@xds/theme-daily`](https://github.com/facebookexperimental/xds/tree/main/packages/themes/daily) | Warm, productivity-focused theme (Lucide icons) |@@ -134,62 +133,28 @@ export default function Page() {}```-### Next.js + StyleX (source build)+### Next.js + StyleX-Compiles XDS from TypeScript source for tree-shaking and custom StyleX overrides.+Use the pre-built dist alongside StyleX for your own styles.```bashnpm install @xds/core @xds/theme-default-npm install -D @xds/build @stylexjs/babel-plugin @babel/core```-See the [`@xds/build` README](../build/README.md) for full `babel.config.js`, `postcss.config.js`, and `next.config.mjs` setup. The key difference from the Tailwind path is that `@xds/build` compiles StyleX from source with split CSS layer prefixes.-**`src/app/globals.css`**```css-@import './layers.css';-@import '@xds/core/reset.css';-@import '@xds/theme-default/theme.css';--@stylex;-```--**`src/app/layers.css`**--```css-@layer reset, xds-base, xds-theme, product;-```--The providers file is the same as above, but import theme from `@xds/theme-default` (not `/built`):--```tsx-import {defaultTheme} from '@xds/theme-default';-```--### Vite + StyleX--```bash-npm install @xds/core @xds/theme-default-npm install -D @xds/build @stylexjs/unplugin @vitejs/plugin-react+@import "@xds/core/reset.css";+@import "@xds/core/xds.css";+@import "@xds/theme-default/theme.css";```-See the [`@xds/build` README](../build/README.md) for full `vite.config.ts` setup with `xdsStylex()`.--### Next.js (dist, no Tailwind, no StyleX)+Providers and layout are the same as the Tailwind example (use `@xds/theme-default/built`).-The lightest path — no build plugins at all.+### Vite```bashnpm install @xds/core @xds/theme-default```-**`src/app/globals.css`**--```css-@import "@xds/core/reset.css";-@import "@xds/core/xds.css";-@import "@xds/theme-default/theme.css";-```--Providers and layout are the same as the Tailwind example (use `@xds/theme-default/built`).+Same CSS imports and providers as above. No build plugins needed — XDS ships pre-built.