From 7d7e306a8ef69169f4af3c4b90a4927037960532 Mon Sep 17 00:00:00 2001 From: Batuhan Wilhelm Date: Wed, 16 Oct 2024 11:20:25 +0300 Subject: [PATCH] fix(docs): update remix docs --- .../docs/routing/integrations/remix/index.md | 79 ++++++++++++++++++- .../docs/routing/router-provider/index.md | 2 +- 2 files changed, 77 insertions(+), 4 deletions(-) diff --git a/documentation/docs/routing/integrations/remix/index.md b/documentation/docs/routing/integrations/remix/index.md index d561e1800e62..b6b5dae3a623 100644 --- a/documentation/docs/routing/integrations/remix/index.md +++ b/documentation/docs/routing/integrations/remix/index.md @@ -4,11 +4,84 @@ title: Remix Refine provides router bindings and utilities for [Remix](https://remix.run). This package will provide easy integration between Refine and **Remix** for both existing projects and new projects without giving up the benefits of **Remix**. - +import { CodeBlock } from "@site/src/theme/CodeBlock/base"; -We recommend using `create refine-app` to initialize your Refine projects. It configures the project according to your needs including SSR with Remix! + - +You can use one of our remix examples to start your project. + + + + + # With Ant Design + {'\n'} + npm create refine-app@latest -- --example with-remix-antd my-refine-remix-app + {'\n'} + # With authentication + {'\n'} + npm create refine-app@latest -- --example with-remix-auth my-refine-remix-app + {'\n'} + # Headless + {'\n'} + npm create refine-app@latest -- --example with-remix-headless my-refine-remix-app + {'\n'} + # With MUI + {'\n'} + npm create refine-app@latest -- --example with-remix-mui my-refine-remix-app + {'\n'} + # With Vite headless + {'\n'} + npm create refine-app@latest -- --example with-remix-vite-headless my-refine-remix-app + + + + + # With Ant Design + {'\n'} + pnpm create refine-app@latest -- --example with-remix-antd my-refine-remix-app + {'\n'} + # With authentication + {'\n'} + pnpm create refine-app@latest -- --example with-remix-auth my-refine-remix-app + {'\n'} + # Headless + {'\n'} + pnpm create refine-app@latest -- --example with-remix-headless my-refine-remix-app + {'\n'} + # With MUI + {'\n'} + pnpm create refine-app@latest -- --example with-remix-mui my-refine-remix-app + {'\n'} + # With Vite headless + {'\n'} + pnpm create refine-app@latest -- --example with-remix-vite-headless my-refine-remix-app + + + + + # With Ant Design + {'\n'} + yarn create refine-app@latest -- --example with-remix-antd my-refine-remix-app + {'\n'} + # With authentication + {'\n'} + yarn create refine-app@latest -- --example with-remix-auth my-refine-remix-app + {'\n'} + # Headless + {'\n'} + yarn create refine-app@latest -- --example with-remix-headless my-refine-remix-app + {'\n'} + # With MUI + {'\n'} + yarn create refine-app@latest -- --example with-remix-mui my-refine-remix-app + {'\n'} + # With Vite headless + {'\n'} + yarn create refine-app@latest -- --example with-remix-vite-headless my-refine-remix-app + + {"> Only supports yarn@1 version."} + + [Refer to the Router Provider documentation for detailed information. →][routerprovider] diff --git a/documentation/docs/routing/router-provider/index.md b/documentation/docs/routing/router-provider/index.md index 4c0f36c2c417..cc422ca276c1 100644 --- a/documentation/docs/routing/router-provider/index.md +++ b/documentation/docs/routing/router-provider/index.md @@ -213,4 +213,4 @@ If you want to use a legacy router provider, you can pass them to the `