Skip to content

Commit

Permalink
Add links to source code
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenbleasel committed Jan 20, 2025
1 parent bc733ca commit 1eed1c5
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
8 changes: 8 additions & 0 deletions apps/docs/app/layout.config.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
import { GithubIcon } from 'lucide-react';
import Image from 'next/image';
import logo from '../public/logo.svg';

Expand All @@ -14,4 +15,11 @@ export const baseOptions: BaseLayoutProps = {
/>
),
},
links: [
{
text: 'GitHub',
url: 'https://github.com/haydenbleasel/kibo',
icon: <GithubIcon />,
},
],
};
22 changes: 22 additions & 0 deletions apps/docs/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Overview
description: Kibo UI is a custom registry of composable, accessible and open source components designed for use with shadcn/ui.
---

import { GithubIcon } from 'lucide-react';

## What is Kibo UI?

Kibo UI components use the [shadcn/ui](https://ui.shadcn.com/) CSS variables and are designed to work neatly with the existing primitives.
Expand All @@ -11,6 +13,26 @@ Much like the core shadcn/ui primitives, the Kibo UI components are effectively

While shadcn/ui focuses on wrapping primitives from Radix UI, Kibo UI is designed to be a more comprehensive library of components that can be used to build more complex applications. The components wrap more complex logic from various headless libraries to provide a more seamless experience.

## Source code

Kibo UI is open source and available on GitHub:

<a className="card block not-prose font-normal group relative my-2 ring-2 ring-transparent rounded-2xl bg-background border overflow-hidden w-full cursor-pointer hover:bg-secondary" target="_blank" rel="noreferrer" href="https://github.com/haydenbleasel/next-forge/issues">
<div className="px-6 py-5 flex items-center space-x-3">
<div className="h-6 w-6 fill-muted-foreground">
<GithubIcon />
</div>
<div>
<h2 className="font-semibold text-base text-foreground">
View the source code
</h2>
<div className="font-normal text-sm text-muted-foreground leading-6 mt-0">
<p>Report bugs or ask for enhancements.</p>
</div>
</div>
</div>
</a>

## Contributing

We welcome contributions! Please see our [Contributing Guide](https://github.com/haydenbleasel/kibo/blob/main/.github/CONTRIBUTING.md) for more information on how to get involved.
1 change: 1 addition & 0 deletions apps/docs/tailwind.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const tailwindConfig: Config = {
'./lib/**/*.{ts,tsx}',
'./app/**/*.{ts,tsx}',
'./providers/**/*.{ts,tsx}',
'./content/**/*.mdx',

// Fumadocs UI
'./node_modules/fumadocs-ui/dist/**/*.js',
Expand Down

0 comments on commit 1eed1c5

Please sign in to comment.