Skip to content

Commit

Permalink
docs: improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sannajammeh committed Nov 15, 2022
1 parent c5735af commit 558c88d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions apps/beta-docs/components/MainPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const Home: NextPage<{}> = ({}) => {
description="Make your Tailwind components re-usable with the power of great DX, Variants and automatic Typescript intellisense"
/>
<GradientBg />
<div className="container mx-auto px-5 relative">
<div className="container mx-auto px-5 relative min-h-screen">
<section className="py-24">
<h1 className="text-center text-5xl font-bold mb-4">
Make your Tailwind components <br /> re-usable
Expand Down Expand Up @@ -49,7 +49,7 @@ const Home: NextPage<{}> = ({}) => {
</div>
<div className="prose prose-slate dark:prose-invert mx-auto">
<pre className="rounded-xl bg-radix-slate2 text-radix-slate11">
<code>npm install @tw-classed/react</code>
<code>npm install @tw-classed/react@alpha</code>
</pre>
</div>
</section>
Expand Down
2 changes: 1 addition & 1 deletion apps/beta-docs/pages/core/Introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Under the hood `@tw-classed/react` uses `@tw-classed/core` to parse the variants
## Installation

```bash
npm install @tw-classed/core
npm install @tw-classed/core@alpha
```

## Usage
Expand Down
6 changes: 3 additions & 3 deletions apps/beta-docs/pages/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ pnpm install @tw-classed/react

## Import it

<>import `classed` from `@tw-classed/react`</>;
<>import `classed` from `@tw-classed/react@alpha`</>;

```tsx
import classed from "@tw-classed/react";
import classed from "@tw-classed/react@alpha";
```

## Use it

Use the `classed` function to create a component and style it with Tailwind

```tsx
import classed from "@tw-classed/react";
import classed from "@tw-classed/react@alpha";

const Button = classed(
"button",
Expand Down

1 comment on commit 558c88d

@vercel
Copy link

@vercel vercel bot commented on 558c88d Nov 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

tw-classed – ./

tw-classed-sannajammeh.vercel.app
tw-classed-git-master-sannajammeh.vercel.app
tw-classed.vercel.app

Please sign in to comment.