Skip to content

Commit

Permalink
polish
Browse files Browse the repository at this point in the history
  • Loading branch information
brillout committed Nov 30, 2024
1 parent 636fb8a commit eb072d4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
12 changes: 9 additions & 3 deletions packages/vike-react-antd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

<br/>

Integrates [Ant Design](https://ant.design) to your [`vike-react`](https://vike.dev/vike-react) app.

## Installation

1. `npm install vike-react-antd antd @ant-design/cssinjs`
Expand Down Expand Up @@ -39,14 +41,12 @@
> [!NOTE]
> The `vike-react-antd` extension requires [`vike-react`](https://vike.dev/vike-react).

> [!NOTE]
> The main purpose of this extension is to simplify the integration of Ant Design with [Server Side Rendering](https://ant.design/docs/react/server-side-rendering).

<br/>

## Settings

`vike-react-antd` provides a configuration `+antd` for customizing Ant Design [Style Compatibility](https://ant.design/docs/react/compatible-style).

```ts
// pages/+antd.ts
export { antd }
Expand All @@ -65,12 +65,18 @@ const antd: Omit<StyleProviderProps, "children"> = {
```

You can remove Ant Design from [some of your pages](https://vike.dev/config#inheritance):

```js
// pages/about/+antd.js
export const antd = null
```

For full customization consider [ejecting](https://vike.dev/eject).

> [!NOTE]
> Consider making a [Pull Request before ejecting](https://vike.dev/eject#when-to-eject).

<br/>

## See also
Expand Down
12 changes: 9 additions & 3 deletions packages/vike-react-chakra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

<br/>

Integrates [Chakra UI](https://www.chakra-ui.com/) to your [`vike-react`](https://vike.dev/vike-react) app.

## Installation

1. `npm install vike-react-chakra @chakra-ui/react @emotion/react`
Expand Down Expand Up @@ -39,14 +41,12 @@
> [!NOTE]
> The `vike-react-chakra` extension requires [`vike-react`](https://vike.dev/vike-react).

> [!NOTE]
> The extension does only one thing: it adds [a Wrapper](https://github.com/vikejs/vike-react/blob/main/packages/vike-react-chakra/Wrapper.tsx) to your pages.

<br/>

## Settings

`vike-react-chakra` provides a configuration `+chakra` for setting the theme system and locale.

```js
// pages/+chakra.js
Expand All @@ -72,12 +72,18 @@ const chakra = {
```

You can remove Chakra from [some of your pages](https://vike.dev/config#inheritance):

```js
// pages/about/+chakra.js
export const chakra = null
```

For full customization consider [ejecting](https://vike.dev/eject).

> [!NOTE]
> Consider making a [Pull Request before ejecting](https://vike.dev/eject#when-to-eject).

<br/>

## See also
Expand Down

0 comments on commit eb072d4

Please sign in to comment.