summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Ben Holmes <hey@bholmes.dev> 2022-07-07 18:19:39 -0400
committerGravatar GitHub <noreply@github.com> 2022-07-07 18:19:39 -0400
commit08fa0772abb49b892fa03198fa16964161b9618d (patch)
tree65ff9bb5b0583124d98fabc761df0af74c9f897e
parent0a156feca0bb169ca5d55e92a8d01b27afbba4ee (diff)
downloadastro-08fa0772abb49b892fa03198fa16964161b9618d.tar.gz
astro-08fa0772abb49b892fa03198fa16964161b9618d.tar.zst
astro-08fa0772abb49b892fa03198fa16964161b9618d.zip
Docs: add adapter heading for configuration docs (#3842)
* Docs: add adapter heading for configuration docs * docs: add adapter example, rework doc links * chore: changeset
-rw-r--r--.changeset/funny-masks-yawn.md5
-rw-r--r--packages/astro/src/@types/astro.ts19
2 files changed, 20 insertions, 4 deletions
diff --git a/.changeset/funny-masks-yawn.md b/.changeset/funny-masks-yawn.md
new file mode 100644
index 000000000..cb0466f75
--- /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 75d63cece..2b56bee8c 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;