mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-07 14:08:47 +00:00
74c4c7508b
* docs: review all docs * fix Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(spinner): reintroduce data-icon attribute guidance in radix spinner docs (#10059) * Initial plan * docs: add data-icon attribute instructions to radix/spinner.mdx button and badge sections Co-authored-by: shadcn <124599+shadcn@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: shadcn <124599+shadcn@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
110 lines
2.4 KiB
Plaintext
110 lines
2.4 KiB
Plaintext
---
|
||
title: Gatsby
|
||
description: Install and configure shadcn/ui for Gatsby.
|
||
---
|
||
|
||
<Callout className="mb-6 border-blue-600 bg-blue-50 dark:border-blue-900 dark:bg-blue-950 [&_code]:bg-blue-100 dark:[&_code]:bg-blue-900">
|
||
**Note:** This guide is for Gatsby with Tailwind CSS v3. For new projects, we
|
||
recommend using one of the other frameworks that support Tailwind CSS v4.
|
||
</Callout>
|
||
|
||
<Steps>
|
||
|
||
### Create project
|
||
|
||
Start by creating a new Gatsby project using `create-gatsby`:
|
||
|
||
```bash
|
||
npm init gatsby
|
||
```
|
||
|
||
### Configure your Gatsby project to use TypeScript and Tailwind CSS
|
||
|
||
You will be asked a few questions to configure your project:
|
||
|
||
```txt showLineNumbers
|
||
✔ What would you like to call your site?
|
||
· your-app-name
|
||
✔ What would you like to name the folder where your site will be created?
|
||
· your-app-name
|
||
✔ Will you be using JavaScript or TypeScript?
|
||
· TypeScript
|
||
✔ Will you be using a CMS?
|
||
· Choose whatever you want
|
||
✔ Would you like to install a styling system?
|
||
· Tailwind CSS
|
||
✔ Would you like to install additional features with other plugins?
|
||
· Choose whatever you want
|
||
✔ Shall we do this? (Y/n) · Yes
|
||
```
|
||
|
||
### Edit tsconfig.json file
|
||
|
||
Add the following code to the `tsconfig.json` file to resolve paths:
|
||
|
||
```ts {4-9} showLineNumbers
|
||
{
|
||
"compilerOptions": {
|
||
// ...
|
||
"baseUrl": ".",
|
||
"paths": {
|
||
"@/*": [
|
||
"./src/*"
|
||
]
|
||
}
|
||
// ...
|
||
}
|
||
}
|
||
```
|
||
|
||
### Create gatsby-node.ts file
|
||
|
||
Create a `gatsby-node.ts` file at the root of your project if it doesn’t already exist, and add the code below to the `gatsby-node` file so your app can resolve paths:
|
||
|
||
```ts
|
||
import * as path from "path"
|
||
|
||
export const onCreateWebpackConfig = ({ actions }) => {
|
||
actions.setWebpackConfig({
|
||
resolve: {
|
||
alias: {
|
||
"@/components": path.resolve(__dirname, "src/components"),
|
||
"@/lib/utils": path.resolve(__dirname, "src/lib/utils"),
|
||
},
|
||
},
|
||
})
|
||
}
|
||
```
|
||
|
||
### Run the CLI
|
||
|
||
Run the `shadcn` init command to set up your project:
|
||
|
||
```bash
|
||
npx shadcn@latest init
|
||
```
|
||
|
||
### That's it
|
||
|
||
You can now start adding components to your project.
|
||
|
||
```bash
|
||
npx shadcn@latest add button
|
||
```
|
||
|
||
The command above will add the `Button` component to your project. You can then import it like this:
|
||
|
||
```tsx {1,6} showLineNumbers
|
||
import { Button } from "@/components/ui/button"
|
||
|
||
export default function Home() {
|
||
return (
|
||
<div>
|
||
<Button>Click me</Button>
|
||
</div>
|
||
)
|
||
}
|
||
```
|
||
|
||
</Steps>
|