A design system in a box.
hip-ui.tngl.io/docs/introduction
add better readme
+11
-33
+11
-33
README.md
+11
-33
README.md
···
6
6
Inspired by tools like [shadcn/ui](https://ui.shadcn.com/docs), Hip UI focuses on shipping application-ready building blocks, not just isolated inputs and buttons.
7
7
The system is built around [React Aria](https://react-spectrum.adobe.com/react-aria/) for accessibility and [StyleX](https://stylexjs.com/) for styling and tokens.
8
8
9
+
[Read the docs.]()
10
+
9
11
## Why Hip UI
10
12
11
13
- Copy components into your codebase and customize them freely.
···
14
16
- Start with foundational primitives and scale up to full application layouts.
15
17
- Explore a broad component set that includes forms, overlays, navigation, data display, and page structure.
16
18
17
-
## Documentation
18
-
19
-
The docs live in this repository and are organized into foundations, components, and showcases.
20
-
21
-
- [Docs app](./apps/docs)
22
-
- [Introduction](./apps/docs/src/docs/introduction.mdx)
23
-
- [Foundations](./apps/docs/src/docs/foundations)
24
-
- [Components](./apps/docs/src/docs/components)
25
-
- [Showcases](./apps/docs/src/docs/showcase)
26
-
27
-
To run the docs locally:
28
-
29
-
```bash
30
-
pnpm install
31
-
pnpm --filter docs dev
32
-
```
33
-
34
-
Then open [http://localhost:3000](http://localhost:3000).
35
-
The root route redirects to the introduction page.
19
+
## Development
36
20
37
21
## Quick Start
38
22
···
64
48
pnpx hip-ui install tooltip
65
49
```
66
50
67
-
## Monorepo Layout
68
-
69
-
- `packages/hip-ui` - the core component source and CLI used to scaffold components.
70
-
- `apps/docs` - the documentation site for foundations, components, and showcases.
71
-
- `apps/example` - a small example app for testing components in an app context.
72
-
- `packages/typescript-config` - shared TypeScript configuration used across the workspace.
73
-
74
51
## Common Commands
75
52
76
53
```bash
···
81
58
pnpm lint
82
59
```
83
60
84
-
## What You Will Find In The Docs
61
+
## Docs Development
85
62
86
-
- Foundations for tokens such as colors, spacing, radius, shadow, typography, and theming.
87
-
- Component documentation covering layout, content, navigation, form controls, overlays, collections, and status UI.
88
-
- Showcase pages that demonstrate how Hip UI can be used to build complete interfaces.
63
+
To run the docs locally:
89
64
90
-
## Development Notes
65
+
```bash
66
+
pnpm install
67
+
pnpm --filter docs dev
68
+
```
91
69
92
-
This repository is organized as a `pnpm` workspace and uses `turbo` for multi-package tasks.
93
-
The docs app is built with Vite and MDX, while the component package contains the install CLI and the source for the design system itself.
70
+
Then open [http://localhost:3000](http://localhost:3000).
71
+
The root route redirects to the introduction page.