Skip to content

Commit fbef9d7

Browse files
committed
docs: add shadcn/ui section to prerequisites
1 parent 6de9924 commit fbef9d7

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

apps/website/src/docs/getting-started/prerequisites.mdx

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ To create your own custom Code Block component, make sure you have the following
88

99
- [Node.js v20](https://nodejs.org/en/download/current) or higher.
1010
- [Typescript v5](https://www.typescriptlang.org/) or higher.
11-
- If you plan to use the [shadcn/ui CLI](https://ui.shadcn.com/docs/cli), make sure you configure the [`components.json`](https://ui.shadcn.com/docs/components-json) file first.
1211

1312
## Styling
1413

@@ -80,6 +79,30 @@ You'll need to install [@base-ui/react](https://base-ui.com/) to use the Blocks
8079
}
8180
```
8281

82+
## shadcn/ui
83+
84+
[shadcn/ui](https://ui.shadcn.com/) is a collection of accessible and customizable UI components styled with Tailwind CSS. It provides a CLI that you can use it to add components to your project using the [`components.json`](https://ui.shadcn.com/docs/components-json) file.
85+
86+
### Add registry
87+
88+
If you don't have a `components.json` file yet, initialize it by running:
89+
90+
<CodeBlockSelectPkg
91+
title="shadcn/ui Init"
92+
type="dlx"
93+
command="shadcn@latest init"
94+
/>
95+
96+
Then, add the [`registries`](https://ui.shadcn.com/docs/components-json#registries) section to your `components.json` file:
97+
98+
```json {3}
99+
{
100+
"registries": {
101+
"@code-blocks": "https://code-blocks.pheralb.dev/r/{name}.json"
102+
}
103+
}
104+
```
105+
83106
## Utilities
84107

85108
All the utilities are built using TypeScript. You'll only need install the highlighter library you choose to use:

0 commit comments

Comments
 (0)