michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: add adapter heading for configuration docs (#3842)

Browse source 
* Docs: add adapter heading for configuration docs

* docs: add adapter example, rework doc links

* chore: changeset
This commit is contained in:
Ben Holmes 2022-07-07 18:19:39 -04:00 committed by GitHub
parent 0a156feca0
commit 08fa0772ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/funny-masks-yawn.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Docs: add complete "adapter" configuration reference

19
packages/astro/src/@types/astro.ts
View file

@ -585,11 +585,22 @@ export interface AstroUserConfig {
};
/**
* @name adapter
* @type {AstroIntegration}
* @default `undefined`
* @docs
* @kind heading
* @name Adapter
* @description
* Add an adapter to build for SSR (server-side rendering). An adapter makes it easy to connect a deployed Astro app to a hosting provider or runtime environment.
*
* Deploy to your favorite server, serverless, or edge host with build adapters. Import one of our first-party adapters for [Netlify](https://docs.astro.build/en/guides/deploy/netlify/#adapter-for-ssredge), [Vercel](https://docs.astro.build/en/guides/deploy/vercel/#adapter-for-ssr), and more to engage Astro SSR.
*
* [See our Server-side Rendering guide](https://docs.astro.build/en/guides/server-side-rendering/) for more on SSR, and [our deployment guides](https://docs.astro.build/en/guides/deploy/) for a complete list of hosts.
*
* ```js
* import netlify from '@astrojs/netlify/functions';
* {
* // Example: Build for Netlify serverless deployment
* adapter: netlify(),
* }
* ```
*/
adapter?: AstroIntegration;