Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs(richtext): the README shows Core's, the theme's and richtext's prebuilt stylesheets (#7582)

Cindy Zhang2366a5833f6a
diff --git a/.changeset/richtext-readme-prebuilt-css.md b/.changeset/richtext-readme-prebuilt-css.md
new file mode 100644
index 0000000000..b4a3ab4721
--- /dev/null
+++ b/.changeset/richtext-readme-prebuilt-css.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/richtext': patch
+---
+
+[docs] The `@astryxdesign/richtext` README shows the full stylesheet setup: Core's `reset.css` and `astryx.css`, your theme's CSS, and `richtext.css`. It says the package ships prebuilt CSS, so you never compile its source, and that `richtext.css` sits in `@layer astryx-base`, so theme overrides win once `reset.css` (or the layer-order line) loads first.
+
+@cixzhang
diff --git a/packages/richtext/README.md b/packages/richtext/README.md
index 4500206caf..89c6d523bb 100644
--- a/packages/richtext/README.md
+++ b/packages/richtext/README.md
@@ -53,11 +53,22 @@ same version; install matching versions. `lexical` and the `@lexical/*` packages
are optional peer dependencies, so a project that only uses the headless
Markdown serializers installs just those.
+RichText ships prebuilt CSS and JS, like `@astryxdesign/core`: import its
+stylesheet beside Core's and your theme's, with no StyleX or Babel setup. Never
+compile richtext's source.
+
```tsx
+import '@astryxdesign/core/reset.css';
import '@astryxdesign/core/astryx.css';
+import '@astryxdesign/theme-neutral/theme.css'; // or your theme's CSS
import '@astryxdesign/richtext/richtext.css';
```
+`richtext.css` emits into `@layer astryx-base`, the layer `astryx.css` opens,
+so your theme's token overrides (`@layer astryx-theme`) win over it, as long
+as Core's `reset.css` (or a `@layer reset, astryx-base, astryx-theme;` line,
+if your app has its own reset) loads first.
+
## Examples
Interactive examples live in Storybook under **RichText/RichTextEditor**
diff --git a/packages/richtext/astryx.integration.mjs b/packages/richtext/astryx.integration.mjs
index 07076851f8..525aca670e 100644
--- a/packages/richtext/astryx.integration.mjs
+++ b/packages/richtext/astryx.integration.mjs
@@ -1,7 +1,7 @@
// Copyright (c) Meta Platforms, Inc. and affiliates.
/**
- * Astryx CLI integration for the canary-only Rich Text package.
+ * Astryx CLI integration for the Rich Text package.
* Package identity and version come from package.json.
*/
export default {