Skip to content

Commit

Permalink
For #20
Browse files Browse the repository at this point in the history
  • Loading branch information
haydenbleasel committed Nov 21, 2024
1 parent 5c6ba16 commit 9acd611
Show file tree
Hide file tree
Showing 6 changed files with 81 additions and 26 deletions.
16 changes: 13 additions & 3 deletions content/docs/calendar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,26 @@ icon: CalendarRange
---

import { AutoTypeTable } from 'fumadocs-typescript/ui';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

<div className="not-prose w-full bg-white dark:bg-neutral-950 border rounded-xl overflow-hidden">
<Calendar />
</div>

## Installation

```sh title="Terminal"
npx roadmap-ui add calendar
```
<Tabs groupId="language" items={['roadmap-ui', 'shadcn']} persist>
<Tab value="roadmap-ui">
```sh
npx roadmap-ui add calendar
```
</Tab>
<Tab value="shadcn">
```sh
npx shadcn-ui@latest add https://www.roadmap-ui.com/calendar.json
```
</Tab>
</Tabs>

## Features

Expand Down
16 changes: 13 additions & 3 deletions content/docs/gantt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,26 @@ icon: SquareChartGantt
---

import { AutoTypeTable } from 'fumadocs-typescript/ui';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

<div className="not-prose w-full bg-white dark:bg-neutral-950 border rounded-xl overflow-hidden" style={{ height: '32rem' }}>
<Gantt />
</div>

## Installation

```sh title="Terminal"
npx roadmap-ui add gantt
```
<Tabs groupId="language" items={['roadmap-ui', 'shadcn']} persist>
<Tab value="roadmap-ui">
```sh
npx roadmap-ui add gantt
```
</Tab>
<Tab value="shadcn">
```sh
npx shadcn-ui@latest add https://www.roadmap-ui.com/gantt.json
```
</Tab>
</Tabs>

## Features

Expand Down
16 changes: 13 additions & 3 deletions content/docs/kanban.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,26 @@ icon: SquareKanban
---

import { AutoTypeTable } from 'fumadocs-typescript/ui';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

<div className="not-prose w-full">
<Kanban />
</div>

## Installation

```sh title="Terminal"
npx roadmap-ui add kanban
```
<Tabs groupId="language" items={['roadmap-ui', 'shadcn']} persist>
<Tab value="roadmap-ui">
```sh
npx roadmap-ui add kanban
```
</Tab>
<Tab value="shadcn">
```sh
npx shadcn-ui@latest add https://www.roadmap-ui.com/kanban.json
```
</Tab>
</Tabs>

## Features

Expand Down
16 changes: 13 additions & 3 deletions content/docs/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,26 @@ icon: List
---

import { AutoTypeTable } from 'fumadocs-typescript/ui';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

<div className="not-prose w-full bg-white dark:bg-neutral-950 border rounded-xl overflow-auto" style={{ height: '32rem' }}>
<List />
</div>

## Installation

```sh title="Terminal"
npx roadmap-ui add list
```
<Tabs groupId="language" items={['roadmap-ui', 'shadcn']} persist>
<Tab value="roadmap-ui">
```sh
npx roadmap-ui add list
```
</Tab>
<Tab value="shadcn">
```sh
npx shadcn-ui@latest add https://www.roadmap-ui.com/list.json
```
</Tab>
</Tabs>

## Features

Expand Down
27 changes: 16 additions & 11 deletions content/docs/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Setup
description: How to install and set up Roadmap UI in your project
---

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

## Prerequisites

Before installing Roadmap UI, make sure you have the following prerequisites:
Expand All @@ -13,17 +15,20 @@ Before installing Roadmap UI, make sure you have the following prerequisites:

## Installation

You can install Roadmap UI components using the `roadmap-ui` CLI, for example:

```sh title="Terminal"
npx roadmap-ui add gantt
```

Alternatively, you can use the `shadcn` CLI and target the component JSON file, like so:

```sh title="Terminal"
npx shadcn@latest add https://www.roadmap-ui.com/gantt.json
```
You can install Roadmap UI components using the `roadmap-ui` or `shadcn` CLI e.g.

<Tabs groupId="language" items={['roadmap-ui', 'shadcn']} persist>
<Tab value="roadmap-ui">
```sh
npx roadmap-ui add gantt
```
</Tab>
<Tab value="shadcn">
```sh
npx shadcn-ui@latest add https://www.roadmap-ui.com/gantt.json
```
</Tab>
</Tabs>

This will install the Roadmap UI components into your project at `@/components/roadmap-ui` (or the relevant folder you specified in the `components.json` file).

Expand Down
16 changes: 13 additions & 3 deletions content/docs/table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,26 @@ icon: TableProperties
---

import { AutoTypeTable } from 'fumadocs-typescript/ui';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

<div className="not-prose w-full bg-white dark:bg-neutral-950 border rounded-xl overflow-auto" style={{ height: '32rem' }}>
<Table />
</div>

## Installation

```sh title="Terminal"
npx roadmap-ui add table
```
<Tabs groupId="language" items={['roadmap-ui', 'shadcn']} persist>
<Tab value="roadmap-ui">
```sh
npx roadmap-ui add table
```
</Tab>
<Tab value="shadcn">
```sh
npx shadcn-ui@latest add https://www.roadmap-ui.com/table.json
```
</Tab>
</Tabs>

## Features

Expand Down

0 comments on commit 9acd611

Please sign in to comment.