Skip to content

Commit

Permalink
fix(docs): fix install instructions for markdown renderer
Browse files Browse the repository at this point in the history
  • Loading branch information
iipanda committed Nov 13, 2024
1 parent 98caf0c commit 36840a6
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion apps/www/content/docs/components/markdown-renderer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,30 @@ npx shadcn@latest add https://shadcn-chatbot-kit.vercel.app/r/markdown-renderer.
<Step>Install the required dependencies</Step>

```bash
npm install react-markdown remark-gfm
npm install react-markdown remark-gfm shiki
```

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="markdown-renderer" />

<Step>Add the following options into `tailwind.config.js`</Step>

<Step>Add the following options into `tailwind.config.js`</Step>

Add the following in the `theme.extend.colors` section of your `tailwind.config.js` file

```javascript title="tailwind.config.js"
// ...
shiki: {
light: "var(--shiki-light)",
"light-bg": "var(--shiki-light-bg)",
dark: "var(--shiki-dark)",
"dark-bg": "var(--shiki-dark-bg)",
},
// ...
```

<Step>Update the import paths to match your project setup.</Step>

</Steps>
Expand Down

0 comments on commit 36840a6

Please sign in to comment.