Skip to content

Commit 9606330

Browse files
committed
feat(README): reset README
1 parent a09b8e4 commit 9606330

File tree

1 file changed

+1
-39
lines changed

1 file changed

+1
-39
lines changed

README.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1 @@
1-
# Example app with [chakra-ui](https://github.com/chakra-ui/chakra-ui) and TypeScript
2-
3-
This example features how to use [chakra-ui](https://github.com/chakra-ui/chakra-ui) as the component library within a Next.js app with TypeScript.
4-
5-
Next.js and chakra-ui have built-in TypeScript declarations, so we'll get autocompletion for their modules straight away.
6-
7-
We are connecting the Next.js `_app.js` with `chakra-ui`'s Provider and theme so the pages can have app-wide dark/light mode. We are also creating some components which shows the usage of `chakra-ui`'s style props.
8-
9-
## Preview
10-
11-
Preview the example live on [StackBlitz](http://stackblitz.com/):
12-
13-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-chakra-ui-typescript)
14-
15-
## Deploy your own
16-
17-
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
18-
19-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-chakra-ui-typescript&project-name=with-chakra-ui-typescript&repository-name=with-chakra-ui-typescript)
20-
21-
## How to use
22-
23-
### Using `create-next-app`
24-
25-
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
26-
27-
```bash
28-
npx create-next-app --example with-chakra-ui-typescript with-chakra-ui-typescript-app
29-
# or
30-
yarn create next-app --example with-chakra-ui-typescript with-chakra-ui-typescript-app
31-
```
32-
33-
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
34-
35-
## Notes
36-
37-
Chakra has supported Gradients and RTL in `v1.1`. To utilize RTL, [add RTL direction and swap](https://chakra-ui.com/docs/features/rtl-support).
38-
39-
If you don't have multi-direction app, you should make `<Html lang="ar" dir="rtl">` inside `_document.ts`.
1+
# HandyDocs

0 commit comments

Comments
 (0)