Skip to content

Commit 8caa456

Browse files
fix: update container-reference.mdx (#12509)
Co-authored-by: Yan <[email protected]>
1 parent 95110bc commit 8caa456

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/content/docs/en/reference/container-reference.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Astro Container API (experimental)
33
sidebar:
44
label: Container API (experimental)
5-
i18nReady: false
5+
i18nReady: true
66
---
77
import Since from '~/components/Since.astro'
88

@@ -125,7 +125,7 @@ const container = await experimental_AstroContainer.create();
125125
const result = await container.renderToString(Card);
126126
```
127127

128-
Under the hood, this function calls [`renderToResponse`](#rendertoresponse) and calls `Response.text()`.
128+
Under the hood, this function calls [`renderToResponse()`](#rendertoresponse) and `Response.text()`.
129129

130130
It also accepts an object as a second argument that can contain a [number of options](#rendering-options).
131131

@@ -145,7 +145,7 @@ It also accepts an object as a second argument that can contain a [number of opt
145145

146146
## Rendering options
147147

148-
Both [`renderToResponse`](#rendertoresponse) and [`renderToString`](#rendertostring) accept an object as their second argument:
148+
Both [`renderToResponse()`](#rendertoresponse) and [`renderToString()`](#rendertostring) accept an object as their second argument:
149149

150150
```ts
151151
export type ContainerRenderOptions = {
@@ -162,7 +162,7 @@ These optional values can be passed to the rendering function in order to provid
162162

163163
### `slots`
164164

165-
**Type**: `Record<string, any>`;
165+
**Type:** `Record<string, any>`
166166

167167
An option to pass content to be rendered with [`<slots>`](/en/basics/astro-components/#slots).
168168

@@ -224,7 +224,7 @@ const result = await container.renderToString(Card, {
224224

225225
### `props` option
226226

227-
**Type**: `Record<string, unknown>`
227+
**Type:** `Record<string, unknown>`
228228

229229
An option to pass [properties](/en/basics/astro-components/#component-props) for Astro components.
230230

@@ -252,7 +252,7 @@ const { name } = Astro.props;
252252

253253
### `request` option
254254

255-
**Type**: `Request`
255+
**Type:** `Request`
256256

257257
An option to pass a `Request` with information about the path/URL the component will render.
258258

@@ -274,7 +274,7 @@ const result = await container.renderToString(Card, {
274274

275275
### `params` option
276276

277-
**Type**: `Record<string, string | undefined>`;
277+
**Type:** `Record<string, string | undefined>`
278278

279279
An object to pass information about the path parameter to an Astro component responsible for [generating dynamic routes](/en/guides/routing/#dynamic-routes).
280280

@@ -300,7 +300,7 @@ const result = await container.renderToString(LocaleSlug, {
300300

301301
### `locals` options
302302

303-
**Type**: `App.Locals`
303+
**Type:** `App.Locals`
304304

305305
An option to pass information from [`Astro.locals`](/en/reference/api-reference/#locals) for rendering your component.
306306

@@ -341,9 +341,9 @@ test("User is out", async () => {
341341

342342
### `routeType` option
343343

344-
**Type**: `"page" | "endpoint"`
344+
**Type:** `"page" | "endpoint"`
345345

346-
An option available when using `renderToResponse` to specify that you are rendering an [endpoint](/en/guides/endpoints/):
346+
An option available when using `renderToResponse()` to specify that you are rendering an [endpoint](/en/guides/endpoints/):
347347

348348
```js
349349
container.renderToString(Endpoint, { routeType: "endpoint" });

0 commit comments

Comments
 (0)