Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions app/docs/getting-started/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import { Metadata } from "next";
import Link from "next/link";

import { Download } from "lucide-react";

import { Button } from "@/components/ui/button";
import {
Card,
CardContent,
CardDescription,
CardHeader,
CardTitle,
} from "@/components/ui/card";

import CopyCommandButton from "../../docs/components/copy-command-button";

export const metadata: Metadata = {
title: "Getting Started",
description:
"Welcome to 8bitcn/ui! This guide will help you set up and start using our retro-styled components in your project.",
};

export default function GettingStartedPage() {
return (
<div className="container mx-auto px-4 py-8 max-w-4xl">
<div className="space-y-8">
{/* Header */}
<div className="text-center space-y-4">
<h1 className="text-4xl font-bold tracking-tight">Getting Started</h1>
<p className="text-xl text-muted-foreground max-w-2xl mx-auto">
Welcome to 8bitcn/ui! This guide will help you set up and start
using our retro-styled components in your project.
</p>
</div>

{/* Quick Start */}
<Card>
<CardHeader>
<CardTitle className="flex items-center gap-2">
<Download className="h-5 w-5" />
Quick Start
</CardTitle>
<CardDescription>
Get up and running with 8bitcn/ui in just a few steps
</CardDescription>
</CardHeader>
<CardContent className="space-y-4">
<div className="space-y-3">
<h3 className="font-semibold">
1. Add the 8bitcn registry to your components.json
</h3>
<div className="bg-muted p-4 rounded-lg">
<pre className="text-sm overflow-x-auto">
{`{
"registries": {
"@8bitcn": "https://8bitcn.com/r/{name}.json"
}
}`}
</pre>
</div>
</div>

<div className="space-y-3">
<h3 className="font-semibold">2. Start adding components!</h3>
<div className="bg-muted p-4 rounded-lg">
<CopyCommandButton
command="npx shadcn@latest add @8bitcn/login-form"
copyCommand="npx shadcn@latest add @8bitcn/login-form"
/>
</div>
</div>
</CardContent>
</Card>

{/* Support */}
<Card>
<CardHeader>
<CardTitle>Need Help?</CardTitle>
<CardDescription>
We&apos;re here to help you get started with 8bitcn/ui
</CardDescription>
</CardHeader>
<CardContent>
<div className="flex flex-col sm:flex-row gap-4">
<Button asChild variant="outline" className="flex-1">
<Link
href="https://github.com/theorcdev/8bitcn"
target="_blank"
>
GitHub Repository
</Link>
</Button>
<Button asChild variant="outline" className="flex-1">
<Link href="/contributors">Meet the Team</Link>
</Button>
<Button asChild className="flex-1">
<Link href="/docs">Documentation</Link>
</Button>
</div>
</CardContent>
</Card>
</div>
</div>
);
}
2 changes: 1 addition & 1 deletion app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export default function Home() {
A set of 8-bit styled components and a code distribution platform. Works
with your favorite frameworks. Open Source. Open Code.
</p>
<Link href="/docs/components/accordion" className="w-fit">
<Link href="/docs/getting-started" className="w-fit">
<Button size="sm" className="w-fit">
Get Started
</Button>
Expand Down
4 changes: 4 additions & 0 deletions config/nav-items.ts
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,10 @@ const components = [

export const navItems = {
header: [
{
label: "Getting Started",
href: "/docs/getting-started",
},
{
label: "Docs",
href: "/docs",
Expand Down