Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/router/framework/react/how-to/setup-ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: How to Set Up Server-Side Rendering (SSR)
---

> [!IMPORTANT] > **[TanStack Start](../../guide/tanstack-start.md) is the recommended way to set up SSR** - it provides SSR, streaming, and deployment with zero configuration.
>
> [!IMPORTANT]
> **[TanStack Start](../../guide/tanstack-start.md) is the recommended way to set up SSR** - it provides SSR, streaming, and deployment with zero configuration.

> Use the manual setup below only if you need to integrate with an existing server.

## Quick Start with TanStack Start
Expand Down Expand Up @@ -423,7 +424,8 @@ export default defineConfig(({ isSsrBuild }) => ({

## Common Problems

> [!TIP] > **Most of these problems are automatically solved by [TanStack Start](../../guide/tanstack-start.md).** The issues below are primarily relevant for manual SSR setups.
> [!TIP]
> **Most of these problems are automatically solved by [TanStack Start](../../guide/tanstack-start.md).** The issues below are primarily relevant for manual SSR setups.

### React Import Errors

Expand Down
5 changes: 3 additions & 2 deletions docs/router/framework/react/llm-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ vibe-rules install cursor

`vibe-rules` supports a variety of editors, including `windsurf`, `claude-code`, and more. For more information on supported editors and how to set them up, refer to the [`vibe-rules` documentation](https://github.com/FutureExcited/vibe-rules).

> [!IMPORTANT] If you're using [Yarn Workspaces](https://yarnpkg.com/features/workspaces), you will need to add the following configuration to your `.yarnrc.yaml` file of your application that uses TanStack Router:
>
> [!IMPORTANT]
> If you're using [Yarn Workspaces](https://yarnpkg.com/features/workspaces), you will need to add the following configuration to your `.yarnrc.yaml` file of your application that uses TanStack Router:
> ```yaml
> pnpFallbackMode: all
> pnpMode: loose
Expand Down
6 changes: 4 additions & 2 deletions docs/router/framework/react/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Before installing TanStack router, please ensure your project meets the followin

[//]: # 'Requirements'

> [!NOTE] Using TypeScript (`v5.3.x or higher`) is recommended for the best development experience, though not strictly required. We aim to support the last 5 minor versions of TypeScript, but using the latest version will help avoid potential issues.
> [!NOTE]
> Using TypeScript (`v5.3.x or higher`) is recommended for the best development experience, though not strictly required. We aim to support the last 5 minor versions of TypeScript, but using the latest version will help avoid potential issues.

TanStack Router is currently only compatible with React (with ReactDOM) and Solid. If you're interested in contributing to support other frameworks, such as React Native, Angular, or Vue, please reach out to us on [Discord](https://tlinz.com/discord).

Expand Down Expand Up @@ -60,7 +61,8 @@ Once installed, you can verify the installation by checking your `package.json`

To quickly scaffold a new project with TanStack Router, you can use the `create-tsrouter-app` command-line tool. This tool sets up a new React application with TanStack Router pre-configured, allowing you to get started quickly.

> [!TIP] For full details on available options and templates, visit the [`create-tsrouter-app` documentation](https://github.com/TanStack/create-tsrouter-app/tree/main/cli/create-tsrouter-app).
> [!TIP]
> For full details on available options and templates, visit the [`create-tsrouter-app` documentation](https://github.com/TanStack/create-tsrouter-app/tree/main/cli/create-tsrouter-app).

To create a new project, run the following command in your terminal:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ File-based routing requires that you follow a few simple file naming conventions

> **💡 Remember:** The file-naming conventions for your project could be affected by what [options](../../../../api/file-based-routing.md) are configured.
> [!NOTE] To escape a trailing underscore, for example `/posts[_].tsx`, usage of the upgraded [Non-Nested Routes](../routing-concepts#non-nested-routes) is required.
> [!NOTE]
> To escape a trailing underscore, for example `/posts[_].tsx`, usage of the upgraded [Non-Nested Routes](../routing-concepts#non-nested-routes) is required.
## Dynamic Path Params

Expand Down
6 changes: 4 additions & 2 deletions docs/start/framework/react/build-from-scratch.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ cd myApp
npm init -y
```

> [!NOTE] > We use `npm` in all of these examples, but you can use your package manager of choice instead.
> [!NOTE]
> We use `npm` in all of these examples, but you can use your package manager of choice instead.
## TypeScript Configuration

Expand All @@ -43,7 +44,8 @@ We highly recommend using TypeScript with TanStack Start. Create a `tsconfig.jso
}
```

> [!NOTE] > Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
> [!NOTE]
> Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
## Install Dependencies

Expand Down
6 changes: 4 additions & 2 deletions docs/start/framework/solid/build-from-scratch.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ cd myApp
npm init -y
```

> [!NOTE] > We use `npm` in all of these examples, but you can use your package manager of choice instead.
> [!NOTE]
> We use `npm` in all of these examples, but you can use your package manager of choice instead.
## TypeScript Configuration

Expand All @@ -42,7 +43,8 @@ We highly recommend using TypeScript with TanStack Start. Create a `tsconfig.jso
}
```

> [!NOTE] > Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
> [!NOTE]
> Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
## Install Dependencies

Expand Down
Loading