Skip to content

Commit bc79c97

Browse files
docs: format callouts to put content on new line (#5927)
1 parent c3af4b8 commit bc79c97

File tree

6 files changed

+22
-12
lines changed

6 files changed

+22
-12
lines changed

docs/router/framework/react/how-to/setup-ssr.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
title: How to Set Up Server-Side Rendering (SSR)
33
---
44

5-
> [!IMPORTANT] > **[TanStack Start](../../guide/tanstack-start.md) is the recommended way to set up SSR** - it provides SSR, streaming, and deployment with zero configuration.
6-
>
5+
> [!IMPORTANT]
6+
> **[TanStack Start](../../guide/tanstack-start.md) is the recommended way to set up SSR** - it provides SSR, streaming, and deployment with zero configuration.
7+
78
> Use the manual setup below only if you need to integrate with an existing server.
89
910
## Quick Start with TanStack Start
@@ -423,7 +424,8 @@ export default defineConfig(({ isSsrBuild }) => ({
423424

424425
## Common Problems
425426

426-
> [!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.
427+
> [!TIP]
428+
> **Most of these problems are automatically solved by [TanStack Start](../../guide/tanstack-start.md).** The issues below are primarily relevant for manual SSR setups.
427429
428430
### React Import Errors
429431

docs/router/framework/react/llm-support.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ vibe-rules install cursor
2323

2424
`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).
2525

26-
> [!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:
27-
>
26+
> [!IMPORTANT]
27+
> 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:
28+
2829
> ```yaml
2930
> pnpFallbackMode: all
3031
> pnpMode: loose

docs/router/framework/react/quick-start.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Before installing TanStack router, please ensure your project meets the followin
1818

1919
[//]: # 'Requirements'
2020

21-
> [!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.
21+
> [!NOTE]
22+
> 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.
2223
2324
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).
2425

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

6162
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.
6263

63-
> [!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).
64+
> [!TIP]
65+
> 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).
6466
6567
To create a new project, run the following command in your terminal:
6668

docs/router/framework/react/routing/file-naming-conventions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ File-based routing requires that you follow a few simple file naming conventions
1919

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

docs/start/framework/react/build-from-scratch.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ cd myApp
2424
npm init -y
2525
```
2626

27-
> [!NOTE] > We use `npm` in all of these examples, but you can use your package manager of choice instead.
27+
> [!NOTE]
28+
> We use `npm` in all of these examples, but you can use your package manager of choice instead.
2829
2930
## TypeScript Configuration
3031

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

46-
> [!NOTE] > Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
47+
> [!NOTE]
48+
> Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
4749
4850
## Install Dependencies
4951

docs/start/framework/solid/build-from-scratch.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ cd myApp
2222
npm init -y
2323
```
2424

25-
> [!NOTE] > We use `npm` in all of these examples, but you can use your package manager of choice instead.
25+
> [!NOTE]
26+
> We use `npm` in all of these examples, but you can use your package manager of choice instead.
2627
2728
## TypeScript Configuration
2829

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

45-
> [!NOTE] > Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
46+
> [!NOTE]
47+
> Enabling `verbatimModuleSyntax` can result in server bundles leaking into client bundles. It is recommended to keep this option disabled.
4648
4749
## Install Dependencies
4850

0 commit comments

Comments
 (0)