Skip to content

Commit 9bba06a

Browse files
chore(docs): update to include tailwind config
1 parent 980e4f0 commit 9bba06a

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

src/docs/pages/GettingStartedPage.tsx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import React from 'react';
22
import { Title } from '../../components/typography/Title';
33
import { Card } from '../../components/card/Card';
44
import { ComponentDemo } from '../components/ComponentDemo';
5+
import { CodeEditor } from '../../components/editor/CodeEditor';
56
import { Code } from '../../components/typography/Code';
67

78
export const GettingStartedPage = () => {
@@ -36,6 +37,33 @@ export const GettingStartedPage = () => {
3637
</Card.Content>
3738
</Card>
3839

40+
<Card>
41+
<Card.Header>
42+
<Title level={2}>Tailwind CSS Configuration</Title>
43+
</Card.Header>
44+
<Card.Content>
45+
<div className="space-y-4">
46+
<p className="text-gray-400">
47+
AV1-C uses Tailwind CSS for styling. You'll need to configure your Tailwind CSS to scan the component classes in the package:
48+
</p>
49+
<CodeEditor
50+
value={`// tailwind.config.js
51+
module.exports = {
52+
content: [
53+
// ... your other content paths
54+
"./node_modules/av1-c/**/*.{js,ts,jsx,tsx}",
55+
],
56+
// ... rest of your config
57+
}`}
58+
language="javascript"
59+
/>
60+
<p className="text-gray-400 mt-4">
61+
This ensures that all the necessary styles for AV1-C components are included in your final CSS bundle.
62+
</p>
63+
</div>
64+
</Card.Content>
65+
</Card>
66+
3967
<Card>
4068
<Card.Header>
4169
<Title level={2}>Quick Start</Title>

0 commit comments

Comments
 (0)