Skip to content
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e8be5ed
docs: update Tailwind CSS setup instructions to include additional St…
aradhyacp Mar 2, 2026
5f325e3
docs: update FAQ to include additional Streamdown module sources in g…
aradhyacp Mar 2, 2026
49f4722
docs: update Tailwind CSS configuration to include additional Streamd…
aradhyacp Mar 2, 2026
f9f46ed
docs: update migration guide to include additional Streamdown module …
aradhyacp Mar 2, 2026
86465df
docs: update Tailwind CSS configuration in SKILL.md to include additi…
aradhyacp Mar 2, 2026
523b282
chore: add changeset for @source documentation updates
aradhyacp Mar 2, 2026
858ceb0
docs: update README to include optional Streamdown plugin installatio…
aradhyacp Mar 3, 2026
7326e2a
docs: update FAQ to include instructions for optional Streamdown plug…
aradhyacp Mar 3, 2026
3892d27
docs: update Tailwind CSS configuration in getting-started.mdx to cla…
aradhyacp Mar 3, 2026
f494c75
docs: add Tailwind CSS configuration instructions for @streamdown/cod…
aradhyacp Mar 3, 2026
d947898
docs: update migration guide to include plugin source path instructio…
aradhyacp Mar 3, 2026
3bdaeb0
docs: add Tailwind CSS integration instructions for @streamdown/cjk p…
aradhyacp Mar 3, 2026
7a1f45a
docs: add Tailwind CSS integration instructions for @streamdown/math …
aradhyacp Mar 3, 2026
cee29cc
docs: add Tailwind CSS integration instructions for @streamdown/merma…
aradhyacp Mar 3, 2026
ccedf4a
docs: update the changeset
aradhyacp Mar 3, 2026
7415198
docs: update Tailwind CSS configuration instructions for clarity
aradhyacp Mar 3, 2026
88d3f63
docs: update links for plugin documentation
aradhyacp Mar 3, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/all-rabbits-mate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"streamdown": minor
---

Updated documentation configuration to include all relevant @streamdown packages.
Added additional @source entries to ensure proper documentation generation across code, CJK, math, and mermaid modules.
13 changes: 13 additions & 0 deletions apps/website/content/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@ Add a `@source` directive to your `globals.css` file with the path to Streamdown
@source "../node_modules/streamdown/dist/*.js";
```

If you install optional plugins, add their matching `@source` lines only for packages you've installed. See the plugin pages for exact paths and examples:

- Code: /docs/plugins/code
- CJK: /docs/plugins/cjk
- Math: /docs/plugins/math
- Mermaid: /docs/plugins/mermaid

Example: to include the code plugin, add this to `globals.css` (adjust the relative path as needed):

```css title="globals.css"
@source "../node_modules/@streamdown/code/dist/*.js";
```

### Tailwind v3

Add Streamdown to your `content` array in `tailwind.config.js`:
Expand Down
13 changes: 13 additions & 0 deletions apps/website/content/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,19 @@ Add the following CSS source directive to your `globals.css` or main CSS file:

The path must be relative from your CSS file to the `node_modules` folder containing `streamdown`. In a standard Next.js project where `globals.css` lives in `app/`, the default path above should work.

If you install optional plugins, add their matching `@source` lines only for packages you've installed. See the plugin pages for exact paths and examples:

- Code: /docs/plugins/code
- CJK: /docs/plugins/cjk
- Math: /docs/plugins/math
- Mermaid: /docs/plugins/mermaid

Example: to include the code plugin, add this to `globals.css` (adjust the relative path as needed):

```css title="globals.css"
@source "../node_modules/@streamdown/code/dist/*.js";
```

### Animation styles

If you're using the built-in `animated` prop for streaming animation, import the animation CSS in your app:
Expand Down
13 changes: 13 additions & 0 deletions apps/website/content/docs/migrate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,19 @@ Streamdown uses Tailwind CSS for styling. Add the source path so Tailwind picks
@source "../node_modules/streamdown/dist/*.js";
```

Add plugin `@source` lines only for packages you have installed. For exact paths and examples, see the plugin pages:

- Code: /docs/plugins/code
- CJK: /docs/plugins/cjk
- Math: /docs/plugins/math
- Mermaid: /docs/plugins/mermaid

Example (add to `globals.css`):

```css
@source "../node_modules/@streamdown/code/dist/*.js";
```

**Tailwind v3** — add to your `tailwind.config.js`:

```js title="tailwind.config.js"
Expand Down
10 changes: 10 additions & 0 deletions apps/website/content/docs/plugins/cjk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ The `@streamdown/cjk` plugin improves handling of CJK (Chinese, Japanese, Korean
npm install @streamdown/cjk
```

## Tailwind CSS (v4)

If you use Tailwind v4, add this to your `globals.css` only when `@streamdown/cjk` is installed:

```css title="globals.css"
@source "../node_modules/@streamdown/cjk/dist/*.js";
```

Adjust the path for monorepos so it points to the correct `node_modules` location.

## Usage

```tsx title="chat.tsx" lineNumbers
Expand Down
10 changes: 10 additions & 0 deletions apps/website/content/docs/plugins/code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ The `@streamdown/code` plugin provides syntax highlighting for code blocks using
npm install @streamdown/code
```

## Tailwind CSS (v4)

If you use Tailwind v4, add this to your `globals.css` only when `@streamdown/code` is installed:

```css title="globals.css"
@source "../node_modules/@streamdown/code/dist/*.js";
```

Adjust the path for monorepos so it points to the correct `node_modules` location.

## Usage

```tsx
Expand Down
10 changes: 10 additions & 0 deletions apps/website/content/docs/plugins/math.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ The `@streamdown/math` plugin renders mathematical expressions using [KaTeX](htt
npm install @streamdown/math
```

## Tailwind CSS (v4)

If you use Tailwind v4, add this to your `globals.css` only when `@streamdown/math` is installed:

```css title="globals.css"
@source "../node_modules/@streamdown/math/dist/*.js";
```

Adjust the path for monorepos so it points to the correct `node_modules` location.

## Usage

```tsx title="chat.tsx" lineNumbers
Expand Down
10 changes: 10 additions & 0 deletions apps/website/content/docs/plugins/mermaid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ The `@streamdown/mermaid` plugin renders [Mermaid](https://mermaid.js.org/) diag
npm install @streamdown/mermaid
```

## Tailwind CSS (v4)

If you use Tailwind v4, add this to your `globals.css` only when `@streamdown/mermaid` is installed:

```css title="globals.css"
@source "../node_modules/@streamdown/mermaid/dist/*.js";
```

Adjust the path for monorepos so it points to the correct `node_modules` location.

## Usage

```tsx title="chat.tsx" lineNumbers
Expand Down
11 changes: 10 additions & 1 deletion packages/streamdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ Then, update your Tailwind `globals.css` to include the following so that Tailwi

The path must be relative from your CSS file to the `node_modules` folder containing `streamdown`. In a standard Next.js project where `globals.css` lives in `app/`, the default path above should work.

If you install optional Streamdown plugins, add their matching `@source` lines from the relevant plugin docs (`/docs/plugins/code`, `/docs/plugins/cjk`, `/docs/plugins/math`, `/docs/plugins/mermaid`). Only include plugin `@source` entries for packages that are actually installed.

Example:

```css
@source "../node_modules/@streamdown/code/dist/*.js";
```


### Monorepo setup

In a monorepo (npm workspaces, Turbo, pnpm, etc.), dependencies are typically hoisted to the root `node_modules`. You need to adjust the relative path to point there:
Expand All @@ -54,7 +63,7 @@ monorepo/
@source "../../../node_modules/streamdown/dist/*.js";
```

Adjust the number of `../` segments based on where your CSS file lives relative to the root `node_modules`.
Adjust the number of `../` segments based on where your CSS file lives relative to the root `node_modules`. If you install Streamdown plugins, add their respective `@source` entries only when those packages are installed.

## Usage

Expand Down
4 changes: 4 additions & 0 deletions skills/streamdown/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ npm install @streamdown/code @streamdown/mermaid @streamdown/math @streamdown/cj
**Tailwind v4** — add to `globals.css`:
```css
@source "../node_modules/streamdown/dist/*.js";
@source "../node_modules/@streamdown/code/dist/*.js";
@source "../node_modules/@streamdown/cjk/dist/*.js";
@source "../node_modules/@streamdown/math/dist/*.js";
@source "../node_modules/@streamdown/mermaid/dist/*.js";
```

**Tailwind v3** — add to `tailwind.config.js`:
Expand Down
Loading