0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/packages/integrations/netlify
Ben Holmes 77aa3a5c50
Docs: netlify adapter site requirement (#2996)
* feat: human-readable error on bad site or base

* fix: human-readable error should have 1 config option

* docs: update README

* chore: changeset

* docs: mention localhost for testing via netlify CLI
2022-04-05 11:25:48 -04:00
..
src Docs: netlify adapter site requirement (#2996) 2022-04-05 11:25:48 -04:00
CHANGELOG.md [ci] format 2022-04-02 19:50:17 +00:00
package.json [ci] release (#2969) 2022-04-02 13:49:27 -06:00
readme.md Docs: netlify adapter site requirement (#2996) 2022-04-05 11:25:48 -04:00
tsconfig.json Netlify adapter (#2879) 2022-03-25 12:08:02 -04:00

@astrojs/netlify

Deploy your server-side rendered (SSR) Astro app to Netlify.

Use this adapter in your Astro configuration file, alongside a valid deployment URL:

import { defineConfig } from 'astro/config';
import netlify from '@astrojs/netlify/functions';

export default defineConfig({
	adapter: netlify(),
  // Where your Netlify app will be deployed.
  // Feel free to use a local URL (i.e. http://localhost:8080)
  // to test local builds via the netlify CLI
  site: 'https://my-production-url.netlify.app',
});

After you build your site the netlify/ folder will contain Netlify Functions in the netlify/functions/ folder.

Now you can deploy!

netlify deploy

Configuration

dist

We build to a netlify directory at the base of your project. To change this, use the dist option:

import { defineConfig } from 'astro/config';
import netlify from '@astrojs/netlify/functions';

export default defineConfig({
  adapter: netlify({
    dist: new URL('./dist/', import.meta.url)
  })
});

And then point to the dist in your netlify.toml:

[functions]
  directory = "dist/functions"