Skip to content

Commit a74f677

Browse files
committed
docs(guides): πŸ“ improve docs/guides
1 parent f54e2ee commit a74f677

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

β€Žpages/guides/typescript-guide.mdxβ€Ž

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import Image from "next/image";
22

33
# TypeScript Support
44

5-
Renderlesskit provides a full typesafe theming system which can help you get
6-
better intellisense while working with the components.
5+
AdaptUI provides a full typesafe theming system which can help you get better
6+
intellisense while working with the components.
77

88
In this guide we are going to see how to setup TypeScript, and see how we can
99
add extra typesafe variants to component themes.
@@ -18,8 +18,8 @@ we can infer it's types.
1818
which helps us infer the type of the customTheme, and provide intellisense.
1919

2020
```ts
21-
// renderlesskit.config.ts
22-
import { extendTheme } from "@renderlesski/react-tailwind";
21+
// adaptui.config.ts
22+
import { extendTheme } from "@adaptui/react-tailwind";
2323

2424
export const customTheme = extendTheme({
2525
extend: {
@@ -34,20 +34,20 @@ export const customTheme = extendTheme({
3434

3535
## Creating declaration file
3636

37-
TypeScript definitions for the Renderlesskit's theme can be extended by using
37+
TypeScript definitions for the AdaptUI's theme can be extended by using
3838
[declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html).
3939
So the first step is creating a declarations file. Let's name it `global.d.ts`
4040
for example.
4141

4242
```ts
4343
// global.d.ts
44-
import { DefaultTheme } from "@renderlesskit/react-tailwind";
44+
import { DefaultTheme } from "@adaptui/react-tailwind";
4545
import { customTheme } from "./my-theme";
4646

4747
type UserTheme = typeof customTheme.extend;
4848

4949
declare global {
50-
namespace Renderlesskit {
50+
namespace AdaptUI {
5151
interface Theme {
5252
components: MergeTheme<DefaultTheme, UserTheme>;
5353
}
@@ -69,6 +69,6 @@ called `red`
6969
width="600"
7070
height="300"
7171
layout="intrinsic"
72-
src="/ts-renderlesskit-variant.png"
72+
src="/ts-adaptui-variant.png"
7373
quality={100}
7474
/>

β€Žpages/guides/usage-with-cra.mdxβ€Ž

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Setting up CRA with Renderlesskit
1+
# Setting up CRA with AdaptUI
22

33
First let's create a new CRA project.
44

@@ -8,32 +8,32 @@ npx create-react-app my-website
88

99
## Setup TailwindCSS
1010

11-
To get started with renderlesskit first step is to setup Tailwind CSS in your
12-
CRA project. Refer to tailwind documentation for
11+
To get started with AdaptUI first step is to setup Tailwind CSS in your CRA
12+
project. Refer to tailwind documentation for
1313
[Setting up Tailwind CSS in a Create React App project](https://tailwindcss.com/docs/guides/create-react-app)
1414

1515
After setting up tailwind in your project, all you need to do inside your
1616
`tailwind.config.js` is import our `preset` function and use it.
1717

1818
```js
1919
module.exports = preset({
20-
presets: [require("@renderlesskit/react-tailwind/preset")],
20+
presets: [require("@adaptui/react-tailwind/preset")],
2121
purge: [
2222
// Make sure to add this purge to generate the component's default styling
23-
"node_modules/@renderlesskit/react-tailwind/**/*",
23+
"node_modules/@adaptui/react-tailwind/**/*",
2424
],
2525
});
2626
```
2727

2828
<Nextra.Callout>
29-
`presets` merges your taiwind config with renderlesskit's internal tailwind
30-
configs and enables certain plugins
29+
`presets` merges your taiwind config with AdaptUI's internal tailwind configs
30+
and enables certain plugins
3131
</Nextra.Callout>
3232

33-
## Renderlesskit Setup
33+
## AdaptUI Setup
3434

3535
After following all the steps and correctly setting up tailwind, now let's add
36-
the `RenderlesskitProvider`
36+
the `AdaptUIProvider`
3737

3838
Follow [Setting Up Provider](/docs/getting-started#setting-up-provider) to setup
3939
the provider for your app.

β€Žpages/guides/usage-with-nextjs.mdxβ€Ž

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Setting up Next.js with Renderlesskit
1+
# Setting up Next.js with AdaptUI
22

33
First let's create a new Nextjs project.
44

@@ -8,32 +8,32 @@ npx create-next-app my-website
88

99
## Setup TailwindCSS
1010

11-
To get started with renderlesskit first step is to setup Tailwind CSS in your
12-
CRA project. Refer to tailwind documentation for
11+
To get started with AdaptUI first step is to setup Tailwind CSS in your CRA
12+
project. Refer to tailwind documentation for
1313
[Setting up Tailwind CSS in a Next.js project](https://tailwindcss.com/docs/guides/nextjs)
1414

1515
After setting up tailwind in your project, all you need to do inside your
1616
`tailwind.config.js` is import our `preset` function and use it.
1717

1818
```js
1919
module.exports = preset({
20-
presets: [require("@renderlesskit/react-tailwind/preset")],
20+
presets: [require("@adaptui/react-tailwind/preset")],
2121
purge: [
2222
// Make sure to add this purge to generate the component's default styling
23-
"node_modules/@renderlesskit/react-tailwind/**/*",
23+
"node_modules/@adaptui/react-tailwind/**/*",
2424
],
2525
});
2626
```
2727

2828
<Nextra.Callout>
29-
`presets` merges your taiwind config with renderlesskit's internal tailwind
30-
configs and enables certain plugins
29+
`presets` merges your taiwind config with AdaptUI's internal tailwind configs
30+
and enables certain plugins
3131
</Nextra.Callout>
3232

33-
## Renderlesskit Setup
33+
## AdaptUI Setup
3434

3535
After following all the steps and correctly setting up tailwind, now let's add
36-
the `RenderlesskitProvider`
36+
the `AdaptUIProvider`
3737

3838
Follow [Setting Up Provider](/docs/getting-started#setting-up-provider) to setup
3939
the provider for your app.

0 commit comments

Comments
Β (0)