Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add undocumented options in integrations-reference.mdx #10822

Merged
Merged
Changes from 1 commit
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
9f697f3
fix: update addDevToolbarApp type
ArmandPhilippot Jan 28, 2025
94490ba
fix: mismatch between paths in addDevToolbarApp code snippets
ArmandPhilippot Jan 28, 2025
0b02aed
consistency: injectRoute and injectTypes was the only objects expanded
ArmandPhilippot Jan 28, 2025
edfcc7e
move `astro:routes:resolved` to keep related hooks together
ArmandPhilippot Jan 28, 2025
04771cc
add missing `buildOutput` option in `astro:config:done`
ArmandPhilippot Jan 28, 2025
f8eaa5a
add missing `toolbar` option in `astro:server:setup`
ArmandPhilippot Jan 28, 2025
d236dfb
add missing `refreshContent` option in Quick API Reference
ArmandPhilippot Jan 28, 2025
d24cbd5
add missing logger in `astro:server:setup` type overview
ArmandPhilippot Jan 28, 2025
22f515a
add missing `middlewareEntryPoint` in `astro:build:ssr`
ArmandPhilippot Jan 28, 2025
60fb911
add missing `pages` option in `astro:build:done`
ArmandPhilippot Jan 28, 2025
62e6de2
consistent types preview (indent, options list, options on new line)
ArmandPhilippot Jan 29, 2025
95d8207
api references formatting
ArmandPhilippot Jan 29, 2025
277d5d2
consistent indentation between code snippets (most use 2 spaces)
ArmandPhilippot Jan 29, 2025
dea2347
add docs for `astro:build:setup` options
ArmandPhilippot Jan 29, 2025
d407744
add docs for `astro:build:generated` options
ArmandPhilippot Jan 29, 2025
985ed43
add partial docs for `astro:build:ssr` options
ArmandPhilippot Jan 29, 2025
c07ab67
provide a more detailed description for the `toolbar` option
ArmandPhilippot Jan 30, 2025
cc35d13
fix the hooks order
ArmandPhilippot Jan 30, 2025
ee538ab
try to improve `astro:build:ssr` options description
ArmandPhilippot Jan 30, 2025
0cb3c8b
add a link to some types
ArmandPhilippot Jan 30, 2025
d113f02
consistency: explicit function notation in headings
ArmandPhilippot Jan 30, 2025
bdfa2ad
fix addWatchFile type
ArmandPhilippot Jan 30, 2025
31e32ce
fix `ins` highlighting, thanks HiDeoo
ArmandPhilippot Jan 30, 2025
d33deff
fix link and code snippet language
ArmandPhilippot Jan 30, 2025
b17e3d8
move types and break up `IntegrationResolvedRoute` and `IntegrationRo…
ArmandPhilippot Jan 31, 2025
eba6fd5
add a link from Hooks to AstroIntegrationLogger
ArmandPhilippot Jan 31, 2025
7ce8386
Merge branch 'main' into fix/integrations-reference
ArmandPhilippot Jan 31, 2025
e02829a
bring back redundancy in headings to avoid links errors
ArmandPhilippot Jan 31, 2025
168cb66
fix last link...
ArmandPhilippot Jan 31, 2025
8dd180f
fix `segments` output example, wrong guess
ArmandPhilippot Jan 31, 2025
a20a6c8
use consistent formatting for `route` option properties (component, p…
ArmandPhilippot Feb 3, 2025
e761fbe
Apply Fryuni's suggestions from code review
ArmandPhilippot Feb 4, 2025
1425152
remove the deprecated option from the Quick API reference
ArmandPhilippot Feb 5, 2025
414a5c9
more accurate `When` description for `astro:route:setup`
ArmandPhilippot Feb 5, 2025
bd09702
Apply edits from T&D
ArmandPhilippot Feb 6, 2025
75e51eb
Merge branch 'main' into fix/integrations-reference
ArmandPhilippot Feb 6, 2025
ba8be88
Merge branch 'main' into fix/integrations-reference
ArmandPhilippot Feb 6, 2025
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
Prev Previous commit
Next Next commit
consistency: explicit function notation in headings
We usually use `addMiddleware()` instead of `addMiddleware` in headings
when the type is a function.
ArmandPhilippot committed Jan 30, 2025
commit d113f0202342f523c9efa2d08620829d8f836551
20 changes: 10 additions & 10 deletions src/content/docs/en/reference/integrations-reference.mdx
Original file line number Diff line number Diff line change
@@ -164,7 +164,7 @@ A read-only copy of the user-supplied [Astro config](/en/reference/configuration

`false` when the dev server starts, `true` when a reload is triggered. Useful to detect when this function is called more than once.

#### `updateConfig` option
#### `updateConfig()` option

<p>

@@ -192,7 +192,7 @@ export default {
}
```

#### `addRenderer` option
#### `addRenderer()` option

<p>

@@ -227,7 +227,7 @@ addWatchFile('/home/user/.../my-config.json');
addWatchFile(new URL('./tailwind.config.js', config.root));
```

#### `addClientDirective` option
#### `addClientDirective()` option

<p>

@@ -294,7 +294,7 @@ declare module 'astro' {
}
```

#### `addDevToolbarApp` option
#### `addDevToolbarApp()` option

<p>

@@ -350,7 +350,7 @@ export default {
},
};
```
#### `addMiddleware` option
#### `addMiddleware()` option

<p>

@@ -414,7 +414,7 @@ export default () => ({
});
```

#### `injectRoute` option
#### `injectRoute()` option

<p>

@@ -473,7 +473,7 @@ injectRoute({
});
```

#### `injectScript` option
#### `injectScript()` option

<p>

@@ -763,7 +763,7 @@ interface IntegrationResolvedRoute {

A read-only copy of the user-supplied [Astro config](/en/reference/configuration-reference/). This is resolved _after_ other integrations have run.

#### `setAdapter` option
#### `setAdapter()` option

<p>

@@ -772,7 +772,7 @@ A read-only copy of the user-supplied [Astro config](/en/reference/configuration

Makes the integration an adapter. Read more in the [adapter API](/en/reference/adapter-reference/).

#### `injectTypes` option
#### `injectTypes()` option

<p>

@@ -897,7 +897,7 @@ A function fired when a dev toolbar app is toggled on or off. The first argument

A function that takes an event name as first argument and a payload as second argument. The payload can be any serializable data. This allows you to send a message to the dev toolbar that an app can listen for.

#### `refreshContent` option
#### `refreshContent()` option

<p>