A design system in a box.
hip-ui.tngl.io/docs/introduction
improve install instructions
+12
-31
-2
apps/docs/src/docs/ai.mdx
-2
apps/docs/src/docs/ai.mdx
···
3
3
description: How to use AI to enhance building with Hip UI.
4
4
---
5
5
6
-
import { MCPInstallationGuide } from "../lib/MCPInstallationGuide";
7
-
8
6
Hip UI interfaces with AI in two main ways:
9
7
10
8
1. **llms.txt/per page markdown** - The docs as static markdown files that can be used as context for AI chats like OpenAi or Claude.
+7
-8
apps/docs/src/docs/introduction.mdx
+7
-8
apps/docs/src/docs/introduction.mdx
···
24
24
To get started with hip you can either install all the components at once:
25
25
26
26
```bash
27
-
pnpx hip-ui install --all
27
+
pnpm dlx hip-ui install --all
28
28
```
29
29
30
-
Or intall components one at a time as you need them:
30
+
Or add a few core building blocks one by one.
31
+
In this situation it makes sense to install hip-ui as a dev dependency so as you install components they come from the same version of the library.
31
32
32
33
```bash
33
-
pnpx hip-ui install button
34
-
pnpx hip-ui install typography
35
-
pnpx hip-ui install flex
36
-
pnpx hip-ui install content
37
-
pnpx hip-ui install copy-to-clipboard-button
38
-
pnpx hip-ui install tooltip
34
+
pnpm dlx hip-ui install theme
35
+
pnpm dlx hip-ui install flex
36
+
pnpm dlx hip-ui install typography
37
+
pnpm dlx hip-ui install button
39
38
```
40
39
41
40
## Navigating the docs
+5
-21
packages/hip-ui/README.md
+5
-21
packages/hip-ui/README.md
···
27
27
28
28
## Quick Start
29
29
30
-
Run the CLI without permanently installing it:
31
-
32
-
```bash
33
-
pnpm dlx hip-ui install button
34
-
```
35
-
36
-
You can also use other package managers:
37
-
38
-
```bash
39
-
npx hip-ui install button
40
-
yarn dlx hip-ui install button
41
-
```
42
-
43
30
To install everything at once:
44
31
45
32
```bash
46
33
pnpm dlx hip-ui install --all
47
34
```
48
35
49
-
To add a few core building blocks one by one:
36
+
Or add a few core building blocks one by one.
37
+
In this situation it makes sense to install hip-ui as a dev dependency so as you install components they come from the same version of the library.
50
38
51
39
```bash
52
40
pnpm dlx hip-ui install theme
···
55
43
pnpm dlx hip-ui install button
56
44
```
57
45
58
-
## Optional Local Install
46
+
## MCP Server
59
47
60
-
If you want to keep using the CLI in the same project, add it as a dev dependency:
61
-
62
-
```bash
63
-
pnpm add -D hip-ui
64
-
pnpm exec hip-ui install button
65
-
```
48
+
To get the most out of using Hip UI in your editor [install the MCP server](https://hip-ui.tngl.io/docs/ai).
49
+
If you plan to use the MCP server it makes sense to install hip-ui as a dev dependency so the docs provided by it match your installed components.
66
50
67
51
## Configuration
68
52