Skip to content

Commit 7e351cc

Browse files
committed
new installation guide
1 parent f1de79a commit 7e351cc

38 files changed

+443
-169
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ Thank you for your interest in contributing to RetroUI 🙏. I hope this guide t
3737

3838
## Adding a New Component
3939

40-
1. Create the main component in `/packages/ui/NewComponent/NewComponent.tsx`
40+
1. Create the main component in `/components/ui/NewComponent/NewComponent.tsx`
4141

4242
```ts
4343
export function NewComponent() {
4444
return <div>This is your component.</div>;
4545
}
4646
```
4747

48-
2. Export your component in `/packages/ui/NewComponent/index.ts` and `/packages/ui/index.ts`
48+
2. Export your component in `/components/ui/NewComponent/index.ts` and `/components/ui/index.ts`
4949

5050
```ts
5151
export * from "./NewComponent";

app/(docs)/docs/[[...slug]]/page.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ export default function page({ params }: IProps) {
4747
return (
4848
<div className="space-y-12 py-8">
4949
<div className="border-b border-black pb-6">
50-
<Text as="h2">{doc.title}</Text>
51-
<p className="text-lg text-muted">{doc.description}</p>
50+
<Text as="h1">{doc.title}</Text>
51+
<p className="text-lg text-muted mt-2">{doc.description}</p>
5252
{doc.links && (
5353
<div className="flex space-x-4 text-sm mt-4">
5454
{doc.links?.api_reference && (

app/(marketing)/page.tsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,10 @@ export default async function Home() {
7373
</Badge>
7474
</Link>
7575

76-
<Text as="h1">Make your projects</Text>
77-
<Text as="h1" className="text-outlined">
76+
<Text as="h1" className="text-5xl lg:text-6xl">
77+
Make your projects
78+
</Text>
79+
<Text as="h1" className="text-5xl lg:text-6xl text-outlined">
7880
stand out!
7981
</Text>
8082

components/MDX.tsx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"use client";
22

3-
import { Text } from "@/components/ui";
3+
import { Alert, Badge, Card, Text } from "@/components/ui";
44
import { useMDXComponent } from "next-contentlayer/hooks";
55
import React, { AnchorHTMLAttributes, HTMLAttributes } from "react";
66
import { ComponentShowcase } from "./ComponentShowcase";
@@ -9,7 +9,8 @@ import { ComponentSource } from "./ComponentSource";
99
import { CodeBlock } from "./CodeBlock";
1010
import Link from "next/link";
1111
import { ComponentInstall } from "./ComponentInstall";
12-
import { TabGroup } from "@headlessui/react";
12+
import Image from "next/image";
13+
import { Tab, TabGroup, TabList, TabPanel, TabPanels } from "@headlessui/react";
1314

1415
const components = (type: "doc" | "blog") => ({
1516
h1: (props: HTMLAttributes<HTMLHeadingElement>) => (
@@ -89,6 +90,16 @@ const components = (type: "doc" | "blog") => ({
8990
{children}
9091
</code>
9192
),
93+
TabGroup,
94+
TabList,
95+
Tab,
96+
TabPanels,
97+
TabPanel,
98+
Link,
99+
Badge,
100+
Image,
101+
Card,
102+
Alert,
92103
ComponentShowcase,
93104
ComponentSource,
94105
ComponentInstall,

components/ui/Text/Text.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const textVariants = cva("font-head", {
88
p: "font-sans text-base",
99
li: "font-sans text-base",
1010
a: "font-sans text-base hover:underline underline-offset-2 decoration-primary-500",
11-
h1: "text-5xl lg:text-6xl font-bold",
11+
h1: "text-4xl lg:text-5xl font-bold",
1212
h2: "text-3xl lg:text-4xl font-semibold",
1313
h3: "text-2xl font-medium",
1414
h4: "text-xl font-normal",

config/components.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,59 +21,59 @@ export const componentConfig: {
2121
accordion: {
2222
name: "accordion",
2323
dependencies: ["@radix-ui/react-accordion", "lucide-react"],
24-
filePath: "packages/ui/Accordions/Accordion.tsx",
24+
filePath: "components/ui/Accordions/Accordion.tsx",
2525
},
2626
alert: {
2727
name: "alert",
28-
filePath: "packages/ui/Alerts/Alert.tsx",
28+
filePath: "components/ui/Alerts/Alert.tsx",
2929
},
3030
avatar: {
3131
name: "avatar",
32-
filePath: "packages/ui/Avatars/Avatar.tsx",
32+
filePath: "components/ui/Avatars/Avatar.tsx",
3333
},
3434
badge: {
3535
name: "badge",
36-
filePath: "packages/ui/Badges/Badge.tsx",
36+
filePath: "components/ui/Badges/Badge.tsx",
3737
},
3838
button: {
3939
name: "button",
40-
filePath: "packages/ui/Buttons/Button.tsx",
40+
filePath: "components/ui/Buttons/Button.tsx",
4141
},
4242
card: {
4343
name: "card",
44-
filePath: "packages/ui/Cards/Card.tsx",
44+
filePath: "components/ui/Cards/Card.tsx",
4545
},
4646
checkbox: {
4747
name: "checkbox",
48-
filePath: "packages/ui/Form/Checkbox.tsx",
48+
filePath: "components/ui/Form/Checkbox.tsx",
4949
},
5050
dialog: {
5151
name: "dialog",
52-
filePath: "packages/ui/Dialog/Dialog.tsx",
52+
filePath: "components/ui/Dialog/Dialog.tsx",
5353
},
5454
input: {
5555
name: "input",
56-
filePath: "packages/ui/Form/Input.tsx",
56+
filePath: "components/ui/Form/Input.tsx",
5757
},
5858
menu: {
5959
name: "menu",
60-
filePath: "packages/ui/Menu/Menu.tsx",
60+
filePath: "components/ui/Menu/Menu.tsx",
6161
},
6262
radio: {
6363
name: "radio",
64-
filePath: "packages/ui/Form/Radio.tsx",
64+
filePath: "components/ui/Form/Radio.tsx",
6565
},
6666
select: {
6767
name: "select",
68-
filePath: "packages/ui/Form/Select.tsx",
68+
filePath: "components/ui/Form/Select.tsx",
6969
},
7070
switch: {
7171
name: "switch",
72-
filePath: "packages/ui/Form/Switch.tsx",
72+
filePath: "components/ui/Form/Switch.tsx",
7373
},
7474
text: {
7575
name: "text",
76-
filePath: "packages/ui/Text/Text.tsx",
76+
filePath: "components/ui/Text/Text.tsx",
7777
},
7878
},
7979
examples: {

config/navigation.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,14 @@ export const navConfig: INavigationConfig = {
1212
sideNavItems: [
1313
{
1414
title: "Getting Started",
15-
children: [{ title: "Introduction", href: "/docs", tag: "Updated" }],
15+
children: [
16+
{ title: "Introduction", href: "/docs", tag: "Updated" },
17+
{
18+
title: "Installation",
19+
href: "/docs/install",
20+
tag: "New",
21+
},
22+
],
1623
},
1724
{
1825
title: "Components",

content/docs/components/accordion.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: This collapsible component let's your users read only the content t
44
lastUpdated: 19 Oct, 2024
55
links:
66
api_reference: https://www.radix-ui.com/primitives/docs/components/accordion#api-reference
7-
source: https://github.com/Logging-Stuff/RetroUI/blob/main/packages/ui/Accordions/Accordion.tsx
7+
source: https://github.com/Logging-Stuff/RetroUI/blob/main/components/ui/Accordions/Accordion.tsx
88
---
99

1010
<ComponentShowcase name="accordion-style-default" />

content/docs/components/button.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Button
33
description: This bold button makes sure your users click on it and perform the actions you want! 🚀
44
lastUpdated: 04 Nov, 2024
55
links:
6-
source: https://github.com/Logging-Stuff/RetroUI/blob/main/packages/ui/Buttons/Button.tsx
6+
source: https://github.com/Logging-Stuff/RetroUI/blob/main/components/ui/Buttons/Button.tsx
77
---
88

99
<ComponentShowcase name="button-style-default" />

content/docs/components/checkbox.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Let users confirm or reject an option.
44
lastUpdated: 13 Feb, 2024
55
links:
66
api_reference: https://www.radix-ui.com/primitives/docs/components/checkbox#api-reference
7-
source: https://github.com/Logging-Stuff/RetroUI/blob/main/packages/ui/Form/Checkbox.tsx
7+
source: https://github.com/Logging-Stuff/RetroUI/blob/main/components/ui/Form/Checkbox.tsx
88
---
99

1010
<ComponentShowcase name="checkbox-style-default" />

0 commit comments

Comments
 (0)