opin-ui 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +42 -3
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,5 +1,44 @@
|
|
|
1
|
-
#
|
|
1
|
+
# opin-ui
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A premium, modern, and highly interactive UI component suite designed for constructing stunning developer portals, documentation portals, and application interfaces.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Rich Aesthetics**: Pre-configured with sleek, curated design options including refined dark mode styling and modern typography.
|
|
8
|
+
- **Dynamic Layouts**: Interactive components designed to adapt beautifully to complex content navigation structures.
|
|
9
|
+
- **Ultra Lightweight**: Designed to bundle cleanly and efficiently into server-side and client-side applications.
|
|
10
|
+
- **Developer First**: Highly customizable configuration and clean APIs to build state-of-the-art web applications.
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
Install `opin-ui` using your preferred package manager:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install opin-ui
|
|
18
|
+
# or
|
|
19
|
+
bun add opin-ui
|
|
20
|
+
# or
|
|
21
|
+
pnpm add opin-ui
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Quick Start
|
|
25
|
+
|
|
26
|
+
Import components and styles into your main application file:
|
|
27
|
+
|
|
28
|
+
```tsx
|
|
29
|
+
import { Page } from 'opin-ui/page';
|
|
30
|
+
import 'opin-ui/dist/style.css';
|
|
31
|
+
|
|
32
|
+
export default function MyDocs() {
|
|
33
|
+
return (
|
|
34
|
+
<Page>
|
|
35
|
+
<h1>Welcome to the Future of Docs</h1>
|
|
36
|
+
<p>opin-ui provides high-performance components out of the box.</p>
|
|
37
|
+
</Page>
|
|
38
|
+
);
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
MIT License.
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "opin-ui",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "The Radix UI version of Opin UI",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Docs",
|
|
7
7
|
"OpinUI"
|
|
8
8
|
],
|
|
9
|
-
"homepage": "https://
|
|
9
|
+
"homepage": "https://squareexp.com",
|
|
10
10
|
"license": "MIT",
|
|
11
11
|
"author": "Squareexp",
|
|
12
12
|
"repository": "github:squareexp/opinui",
|