Skip to content

Commit

Permalink
Docs: add adapter heading for configuration docs (#3842)
Browse files Browse the repository at this point in the history
* Docs: add adapter heading for configuration docs

* docs: add adapter example, rework doc links

* chore: changeset
  • Loading branch information
bholmesdev authored Jul 7, 2022
1 parent 0a156fe commit 08fa077
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .changeset/funny-masks-yawn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Docs: add complete "adapter" configuration reference
19 changes: 15 additions & 4 deletions packages/astro/src/@types/astro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down

0 comments on commit 08fa077

Please sign in to comment.