From 08fa0772abb49b892fa03198fa16964161b9618d Mon Sep 17 00:00:00 2001 From: Ben Holmes Date: Thu, 7 Jul 2022 18:19:39 -0400 Subject: [PATCH] Docs: add adapter heading for configuration docs (#3842) * Docs: add adapter heading for configuration docs * docs: add adapter example, rework doc links * chore: changeset --- .changeset/funny-masks-yawn.md | 5 +++++ packages/astro/src/@types/astro.ts | 19 +++++++++++++++---- 2 files changed, 20 insertions(+), 4 deletions(-) create mode 100644 .changeset/funny-masks-yawn.md diff --git a/.changeset/funny-masks-yawn.md b/.changeset/funny-masks-yawn.md new file mode 100644 index 000000000000..cb0466f7595a --- /dev/null +++ b/.changeset/funny-masks-yawn.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Docs: add complete "adapter" configuration reference diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 75d63cece131..2b56bee8c66f 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -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;