Skip to content

Commit

Permalink
docs: styled markdown (#651)
Browse files Browse the repository at this point in the history
  • Loading branch information
Yonom authored Aug 7, 2024
1 parent e139c12 commit 55a2fc6
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ Allow the assistant to display rich text using markdown.
import { Step, Steps } from "fumadocs-ui/components/steps";
import { Callout } from "fumadocs-ui/components/callout";

<Callout type="warn">
Make sure to upgrade `@assistant-ui/react` to `>=0.2`.
</Callout>

<Callout>
Markdown support is alraedy included in the `npx assistant-ui@latest add
thread-full` template.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/ui/shadcn-ui/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"title": "shadcn-ui",
"pages": ["Thread", "AssistantModal", "AssistantSidebar"]
"pages": ["Thread", "AssistantModal", "AssistantSidebar", "Markdown", "..."]
}
88 changes: 88 additions & 0 deletions apps/docs/content/docs/ui/styled/Markdown.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Markdown
---

Allow the assistant to display rich text using markdown.

import { Step, Steps } from "fumadocs-ui/components/steps";
import { Callout } from "fumadocs-ui/components/callout";
import { Tabs } from "fumadocs-ui/components/tabs";

## Enabling markdown support

<Steps>

<Step>
### Install `@assistant-ui/react-markdown`

```sh npm2yarn
npm install @assistant-ui/react-markdown
```

</Step>
<Step>

### Setup styles

<Tabs items={["Tailwind", "Tailwind + shadcn-ui", "Not using Tailwind"]}>

```ts {3} title="/tailwind.config.ts" tab="Tailwind"
{
plugins: [
require("tailwindcss-animate"),
require("@assistant-ui/react/tailwindcss"),
require("@assistant-ui/react-markdown/tailwindcss"),
],
}
```

```ts title="/tailwind.config.ts" tab="Tailwind + shadcn-ui"
{
plugins: [
require("tailwindcss-animate"),
require("@assistant-ui/react/tailwindcss")({ shadcn: true }),
require("@assistant-ui/react-markdown/tailwindcss"),
],
}
```

```ts title="/app/layout.tsx" tab="Not using Tailwind"
import "@assistant-ui/react/styles/index.css";
import "@assistant-ui/react-markdown/styles/index.css";
```

</Tabs>

</Step>

<Step>

### Define a `MarkdownText` component

```tsx {1} twoslash title="@/components/markdown-text.tsx"
import { makeMarkdownText } from "@assistant-ui/react-markdown";

export const MarkdownText = makeMarkdownText();
```

</Step>

<Step>

### Use it with `Thread`

Pass the `MarkdownText` component to your `Thread` component.

```tsx {1, 7}
import { MarkdownText } from "@/components/markdown-text";

const Home = () => {
return (
<Thread assistantMessage={{ components: { Text: MarkdownText } }}>
);
};
```

</Step>

</Steps>
2 changes: 1 addition & 1 deletion apps/docs/content/docs/ui/styled/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"title": "Styled Components",
"pages": ["Thread", "AssistantModal", "Decomposition"]
"pages": ["Thread", "AssistantModal", "Markdown", "Decomposition", "..."]
}

0 comments on commit 55a2fc6

Please sign in to comment.