Upload folder using huggingface_hub

1e92f2d verified about 1 year ago

12.5 kB

---
title: How to create a static export of your Next.js application
nav_title: Static Exports
description: Next.js enables starting as a static site or Single-Page Application (SPA), then later optionally upgrading to use features that require a server.
---

{/* The content of this doc is shared between the app and pages router. You can use the `<PagesOnly>Content</PagesOnly>` component to add content that is specific to the Pages Router. Any shared content should not be wrapped in a component. */}

Next.js enables starting as a static site or Single-Page Application (SPA), then later optionally upgrading to use features that require a server.

When running `next build`, Next.js generates an HTML file per route. By breaking a strict SPA into individual HTML files, Next.js can avoid loading unnecessary JavaScript code on the client-side, reducing the bundle size and enabling faster page loads.

Since Next.js supports this static export, it can be deployed and hosted on any web server that can serve HTML/CSS/JS static assets.

## Configuration

To enable a static export, change the output mode inside `next.config.js`:

```js filename="next.config.js" highlight={5}
/**
 * @type {import('next').NextConfig}
 */
const nextConfig = {
  output: 'export',

  // Optional: Change links `/me` -> `/me/` and emit `/me.html` -> `/me/index.html`
  // trailingSlash: true,

  // Optional: Prevent automatic `/me` -> `/me/`, instead preserve `href`
  // skipTrailingSlashRedirect: true,

  // Optional: Change the output directory `out` -> `dist`
  // distDir: 'dist',
}

module.exports = nextConfig
```

After running `next build`, Next.js will create an `out` folder with the HTML/CSS/JS assets for your application.

<PagesOnly>

You can utilize [`getStaticProps`](/docs/pages/building-your-application/data-fetching/get-static-props) and [`getStaticPaths`](/docs/pages/building-your-application/data-fetching/get-static-paths) to generate an HTML file for each page in your `pages` directory (or more for [dynamic routes](/docs/app/api-reference/file-conventions/dynamic-routes)).

</PagesOnly>

<AppOnly>

## Supported Features

The core of Next.js has been designed to support static exports.

### Server Components

When you run `next build` to generate a static export, Server Components consumed inside the `app` directory will run during the build, similar to traditional static-site generation.

The resulting component will be rendered into static HTML for the initial page load and a static payload for client navigation between routes. No changes are required for your Server Components when using the static export, unless they consume [dynamic server functions](#unsupported-features).

```tsx filename="app/page.tsx" switcher
export default async function Page() {
  // This fetch will run on the server during `next build`
  const res = await fetch('https://api.example.com/...')
  const data = await res.json()

  return <main>...</main>
}
```

### Client Components

If you want to perform data fetching on the client, you can use a Client Component with [SWR](https://github.com/vercel/swr) to memoize requests.

```tsx filename="app/other/page.tsx" switcher
'use client'

import useSWR from 'swr'

const fetcher = (url: string) => fetch(url).then((r) => r.json())

export default function Page() {
  const { data, error } = useSWR(
    `https://jsonplaceholder.typicode.com/posts/1`,
    fetcher
  )
  if (error) return 'Failed to load'
  if (!data) return 'Loading...'

  return data.title
}
```

```jsx filename="app/other/page.js" switcher
'use client'

import useSWR from 'swr'

const fetcher = (url) => fetch(url).then((r) => r.json())

export default function Page() {
  const { data, error } = useSWR(
    `https://jsonplaceholder.typicode.com/posts/1`,
    fetcher
  )
  if (error) return 'Failed to load'
  if (!data) return 'Loading...'

  return data.title
}
```

Since route transitions happen client-side, this behaves like a traditional SPA. For example, the following index route allows you to navigate to different posts on the client:

```tsx filename="app/page.tsx" switcher
import Link from 'next/link'

export default function Page() {
  return (
    <>
      <h1>Index Page</h1>
      <hr />
      <ul>
        <li>
          <Link href="/post/1">Post 1</Link>
        </li>
        <li>
          <Link href="/post/2">Post 2</Link>
        </li>
      </ul>
    </>
  )
}
```

```jsx filename="app/page.js" switcher
import Link from 'next/link'

export default function Page() {
  return (
    <>
      <h1>Index Page</h1>
      <p>
        <Link href="/other">Other Page</Link>
      </p>
    </>
  )
}
```

</AppOnly>

<PagesOnly>

## Supported Features

The majority of core Next.js features needed to build a static site are supported, including:

- [Dynamic Routes when using `getStaticPaths`](/docs/app/api-reference/file-conventions/dynamic-routes)
- Prefetching with `next/link`
- Preloading JavaScript
- [Dynamic Imports](/docs/pages/guides/lazy-loading)
- Any styling options (e.g. CSS Modules, styled-jsx)
- [Client-side data fetching](/docs/pages/building-your-application/data-fetching/client-side)
- [`getStaticProps`](/docs/pages/building-your-application/data-fetching/get-static-props)
- [`getStaticPaths`](/docs/pages/building-your-application/data-fetching/get-static-paths)

</PagesOnly>

### Image Optimization

[Image Optimization](/docs/app/api-reference/components/image) through `next/image` can be used with a static export by defining a custom image loader in `next.config.js`. For example, you can optimize images with a service like Cloudinary:

```js filename="next.config.js"
/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export',
  images: {
    loader: 'custom',
    loaderFile: './my-loader.ts',
  },
}

module.exports = nextConfig
```

This custom loader will define how to fetch images from a remote source. For example, the following loader will construct the URL for Cloudinary:

```ts filename="my-loader.ts" switcher
export default function cloudinaryLoader({
  src,
  width,
  quality,
}: {
  src: string
  width: number
  quality?: number
}) {
  const params = ['f_auto', 'c_limit', `w_${width}`, `q_${quality || 'auto'}`]
  return `https://res.cloudinary.com/demo/image/upload/${params.join(
    ','
  )}${src}`
}
```

```js filename="my-loader.js" switcher
export default function cloudinaryLoader({ src, width, quality }) {
  const params = ['f_auto', 'c_limit', `w_${width}`, `q_${quality || 'auto'}`]
  return `https://res.cloudinary.com/demo/image/upload/${params.join(
    ','
  )}${src}`
}
```

You can then use `next/image` in your application, defining relative paths to the image in Cloudinary:

```tsx filename="app/page.tsx" switcher
import Image from 'next/image'

export default function Page() {
  return <Image alt="turtles" src="/turtles.jpg" width={300} height={300} />
}
```

```jsx filename="app/page.js" switcher
import Image from 'next/image'

export default function Page() {
  return <Image alt="turtles" src="/turtles.jpg" width={300} height={300} />
}
```

<AppOnly>

### Route Handlers

Route Handlers will render a static response when running `next build`. Only the `GET` HTTP verb is supported. This can be used to generate static HTML, JSON, TXT, or other files from cached or uncached data. For example:

```ts filename="app/data.json/route.ts" switcher
export async function GET() {
  return Response.json({ name: 'Lee' })
}
```

```js filename="app/data.json/route.js" switcher
export async function GET() {
  return Response.json({ name: 'Lee' })
}
```

The above file `app/data.json/route.ts` will render to a static file during `next build`, producing `data.json` containing `{ name: 'Lee' }`.

If you need to read dynamic values from the incoming request, you cannot use a static export.

### Browser APIs

Client Components are pre-rendered to HTML during `next build`. Because [Web APIs](https://developer.mozilla.org/docs/Web/API) like `window`, `localStorage`, and `navigator` are not available on the server, you need to safely access these APIs only when running in the browser. For example:

```jsx
'use client';

import { useEffect } from 'react';

export default function ClientComponent() {
  useEffect(() => {
    // You now have access to `window`
    console.log(window.innerHeight);
  }, [])

  return ...;
}
```

</AppOnly>

## Unsupported Features

Features that require a Node.js server, or dynamic logic that cannot be computed during the build process, are **not** supported:

<AppOnly>

- [Dynamic Routes](/docs/app/api-reference/file-conventions/dynamic-routes) with `dynamicParams: true`
- [Dynamic Routes](/docs/app/api-reference/file-conventions/dynamic-routes) without `generateStaticParams()`
- [Route Handlers](/docs/app/api-reference/file-conventions/route) that rely on Request
- [Cookies](/docs/app/api-reference/functions/cookies)
- [Rewrites](/docs/app/api-reference/config/next-config-js/rewrites)
- [Redirects](/docs/app/api-reference/config/next-config-js/redirects)
- [Headers](/docs/app/api-reference/config/next-config-js/headers)
- [Middleware](/docs/app/api-reference/file-conventions/middleware)
- [Incremental Static Regeneration](/docs/app/guides/incremental-static-regeneration)
- [Image Optimization](/docs/app/api-reference/components/image) with the default `loader`
- [Draft Mode](/docs/app/guides/draft-mode)
- [Server Actions](/docs/app/getting-started/updating-data)
- [Intercepting Routes](/docs/app/api-reference/file-conventions/intercepting-routes)

Attempting to use any of these features with `next dev` will result in an error, similar to setting the [`dynamic`](/docs/app/api-reference/file-conventions/route-segment-config#dynamic) option to `error` in the root layout.

```jsx
export const dynamic = 'error'
```

</AppOnly>

<PagesOnly>

- [Internationalized Routing](/docs/pages/guides/internationalization)
- [API Routes](/docs/pages/building-your-application/routing/api-routes)
- [Rewrites](/docs/pages/api-reference/config/next-config-js/rewrites)
- [Redirects](/docs/pages/api-reference/config/next-config-js/redirects)
- [Headers](/docs/pages/api-reference/config/next-config-js/headers)
- [Middleware](/docs/pages/api-reference/file-conventions/middleware)
- [Incremental Static Regeneration](/docs/pages/guides/incremental-static-regeneration)
- [Image Optimization](/docs/pages/api-reference/components/image) with the default `loader`
- [Draft Mode](/docs/pages/guides/draft-mode)
- [`getStaticPaths` with `fallback: true`](/docs/pages/api-reference/functions/get-static-paths#fallback-true)
- [`getStaticPaths` with `fallback: 'blocking'`](/docs/pages/api-reference/functions/get-static-paths#fallback-blocking)
- [`getServerSideProps`](/docs/pages/building-your-application/data-fetching/get-server-side-props)

</PagesOnly>

## Deploying

With a static export, Next.js can be deployed and hosted on any web server that can serve HTML/CSS/JS static assets.

When running `next build`, Next.js generates the static export into the `out` folder. For example, let's say you have the following routes:
- `/`
- `/blog/[id]`
After running `next build`, Next.js will generate the following files:
- `/out/index.html`
- `/out/404.html`
- `/out/blog/post-1.html`
- `/out/blog/post-2.html`
If you are using a static host like Nginx, you can configure rewrites from incoming requests to the correct files:
```nginx filename="nginx.conf"
server {
  listen 80;
  server_name acme.com;
  root /var/www/out;
  location / {
      try_files $uri $uri.html $uri/ =404;
  }
  # This is necessary when `trailingSlash: false`.
  # You can omit this when `trailingSlash: true`.
  location /blog/ {
      rewrite ^/blog/(.*)$ /blog/$1.html break;
  }
  error_page 404 /404.html;
  location = /404.html {
      internal;
  }
}
```
## Version History
| Version   | Changes                                                                                                              |
| --------- | -------------------------------------------------------------------------------------------------------------------- |
| `v14.0.0` | `next export` has been removed in favor of `"output": "export"`                                                      |
| `v13.4.0` | App Router (Stable) adds enhanced static export support, including using React Server Components and Route Handlers. |
| `v13.3.0` | `next export` is deprecated and replaced with `"output": "export"`                                                   |

	---
	title: How to create a static export of your Next.js application
	nav_title: Static Exports
	description: Next.js enables starting as a static site or Single-Page Application (SPA), then later optionally upgrading to use features that require a server.
	---

	{/* The content of this doc is shared between the app and pages router. You can use the `<PagesOnly>Content</PagesOnly>` component to add content that is specific to the Pages Router. Any shared content should not be wrapped in a component. */}

	Next.js enables starting as a static site or Single-Page Application (SPA), then later optionally upgrading to use features that require a server.

	When running `next build`, Next.js generates an HTML file per route. By breaking a strict SPA into individual HTML files, Next.js can avoid loading unnecessary JavaScript code on the client-side, reducing the bundle size and enabling faster page loads.

	Since Next.js supports this static export, it can be deployed and hosted on any web server that can serve HTML/CSS/JS static assets.

	## Configuration

	To enable a static export, change the output mode inside `next.config.js`:

	```js filename="next.config.js" highlight={5}
	/**
	* @type {import('next').NextConfig}
	*/
	const nextConfig = {
	output: 'export',

	// Optional: Change links `/me` -> `/me/` and emit `/me.html` -> `/me/index.html`
	// trailingSlash: true,

	// Optional: Prevent automatic `/me` -> `/me/`, instead preserve `href`
	// skipTrailingSlashRedirect: true,

	// Optional: Change the output directory `out` -> `dist`
	// distDir: 'dist',
	}

	module.exports = nextConfig
	```

	After running `next build`, Next.js will create an `out` folder with the HTML/CSS/JS assets for your application.

	<PagesOnly>

	You can utilize [`getStaticProps`](/docs/pages/building-your-application/data-fetching/get-static-props) and [`getStaticPaths`](/docs/pages/building-your-application/data-fetching/get-static-paths) to generate an HTML file for each page in your `pages` directory (or more for [dynamic routes](/docs/app/api-reference/file-conventions/dynamic-routes)).

	</PagesOnly>

	<AppOnly>

	## Supported Features

	The core of Next.js has been designed to support static exports.

	### Server Components

	When you run `next build` to generate a static export, Server Components consumed inside the `app` directory will run during the build, similar to traditional static-site generation.

	The resulting component will be rendered into static HTML for the initial page load and a static payload for client navigation between routes. No changes are required for your Server Components when using the static export, unless they consume [dynamic server functions](#unsupported-features).

	```tsx filename="app/page.tsx" switcher
	export default async function Page() {
	// This fetch will run on the server during `next build`
	const res = await fetch('https://api.example.com/...')
	const data = await res.json()

	return <main>...</main>
	}
	```

	### Client Components

	If you want to perform data fetching on the client, you can use a Client Component with [SWR](https://github.com/vercel/swr) to memoize requests.

	```tsx filename="app/other/page.tsx" switcher
	'use client'

	import useSWR from 'swr'

	const fetcher = (url: string) => fetch(url).then((r) => r.json())

	export default function Page() {
	const { data, error } = useSWR(
	`https://jsonplaceholder.typicode.com/posts/1`,
	fetcher
	)
	if (error) return 'Failed to load'
	if (!data) return 'Loading...'

	return data.title
	}
	```

	```jsx filename="app/other/page.js" switcher
	'use client'

	import useSWR from 'swr'

	const fetcher = (url) => fetch(url).then((r) => r.json())

	export default function Page() {
	const { data, error } = useSWR(
	`https://jsonplaceholder.typicode.com/posts/1`,
	fetcher
	)
	if (error) return 'Failed to load'
	if (!data) return 'Loading...'

	return data.title
	}
	```

	Since route transitions happen client-side, this behaves like a traditional SPA. For example, the following index route allows you to navigate to different posts on the client:

	```tsx filename="app/page.tsx" switcher
	import Link from 'next/link'

	export default function Page() {
	return (
	<>
	<h1>Index Page</h1>
	<hr />
	<ul>
	<li>
	<Link href="/post/1">Post 1</Link>
	</li>
	<li>
	<Link href="/post/2">Post 2</Link>
	</li>
	</ul>
	</>
	)
	}
	```

	```jsx filename="app/page.js" switcher
	import Link from 'next/link'

	export default function Page() {
	return (
	<>
	<h1>Index Page</h1>
	<p>
	<Link href="/other">Other Page</Link>
	</p>
	</>
	)
	}
	```

	</AppOnly>

	<PagesOnly>

	## Supported Features

	The majority of core Next.js features needed to build a static site are supported, including:

	- [Dynamic Routes when using `getStaticPaths`](/docs/app/api-reference/file-conventions/dynamic-routes)
	- Prefetching with `next/link`
	- Preloading JavaScript
	- [Dynamic Imports](/docs/pages/guides/lazy-loading)
	- Any styling options (e.g. CSS Modules, styled-jsx)
	- [Client-side data fetching](/docs/pages/building-your-application/data-fetching/client-side)
	- [`getStaticProps`](/docs/pages/building-your-application/data-fetching/get-static-props)
	- [`getStaticPaths`](/docs/pages/building-your-application/data-fetching/get-static-paths)

	</PagesOnly>

	### Image Optimization

	[Image Optimization](/docs/app/api-reference/components/image) through `next/image` can be used with a static export by defining a custom image loader in `next.config.js`. For example, you can optimize images with a service like Cloudinary:

	```js filename="next.config.js"
	/** @type {import('next').NextConfig} */
	const nextConfig = {
	output: 'export',
	images: {
	loader: 'custom',
	loaderFile: './my-loader.ts',
	},
	}

	module.exports = nextConfig
	```

	This custom loader will define how to fetch images from a remote source. For example, the following loader will construct the URL for Cloudinary:

	```ts filename="my-loader.ts" switcher
	export default function cloudinaryLoader({
	src,
	width,
	quality,
	}: {
	src: string
	width: number
	quality?: number
	}) {
	const params = ['f_auto', 'c_limit', `w_${width}`, `q_${quality \|\| 'auto'}`]
	return `https://res.cloudinary.com/demo/image/upload/${params.join(
	','
	)}${src}`
	}
	```

	```js filename="my-loader.js" switcher
	export default function cloudinaryLoader({ src, width, quality }) {
	const params = ['f_auto', 'c_limit', `w_${width}`, `q_${quality \|\| 'auto'}`]
	return `https://res.cloudinary.com/demo/image/upload/${params.join(
	','
	)}${src}`
	}
	```

	You can then use `next/image` in your application, defining relative paths to the image in Cloudinary:

	```tsx filename="app/page.tsx" switcher
	import Image from 'next/image'

	export default function Page() {
	return <Image alt="turtles" src="/turtles.jpg" width={300} height={300} />
	}
	```

	```jsx filename="app/page.js" switcher
	import Image from 'next/image'

	export default function Page() {
	return <Image alt="turtles" src="/turtles.jpg" width={300} height={300} />
	}
	```

	<AppOnly>

	### Route Handlers

	Route Handlers will render a static response when running `next build`. Only the `GET` HTTP verb is supported. This can be used to generate static HTML, JSON, TXT, or other files from cached or uncached data. For example:

	```ts filename="app/data.json/route.ts" switcher
	export async function GET() {
	return Response.json({ name: 'Lee' })
	}
	```

	```js filename="app/data.json/route.js" switcher
	export async function GET() {
	return Response.json({ name: 'Lee' })
	}
	```

	The above file `app/data.json/route.ts` will render to a static file during `next build`, producing `data.json` containing `{ name: 'Lee' }`.

	If you need to read dynamic values from the incoming request, you cannot use a static export.

	### Browser APIs

	Client Components are pre-rendered to HTML during `next build`. Because [Web APIs](https://developer.mozilla.org/docs/Web/API) like `window`, `localStorage`, and `navigator` are not available on the server, you need to safely access these APIs only when running in the browser. For example:

	```jsx
	'use client';

	import { useEffect } from 'react';

	export default function ClientComponent() {
	useEffect(() => {
	// You now have access to `window`
	console.log(window.innerHeight);
	}, [])

	return ...;
	}
	```

	</AppOnly>

	## Unsupported Features

	Features that require a Node.js server, or dynamic logic that cannot be computed during the build process, are not supported:

	<AppOnly>

	- [Dynamic Routes](/docs/app/api-reference/file-conventions/dynamic-routes) with `dynamicParams: true`
	- [Dynamic Routes](/docs/app/api-reference/file-conventions/dynamic-routes) without `generateStaticParams()`
	- [Route Handlers](/docs/app/api-reference/file-conventions/route) that rely on Request
	- [Cookies](/docs/app/api-reference/functions/cookies)
	- [Rewrites](/docs/app/api-reference/config/next-config-js/rewrites)
	- [Redirects](/docs/app/api-reference/config/next-config-js/redirects)
	- [Headers](/docs/app/api-reference/config/next-config-js/headers)
	- [Middleware](/docs/app/api-reference/file-conventions/middleware)
	- [Incremental Static Regeneration](/docs/app/guides/incremental-static-regeneration)
	- [Image Optimization](/docs/app/api-reference/components/image) with the default `loader`
	- [Draft Mode](/docs/app/guides/draft-mode)
	- [Server Actions](/docs/app/getting-started/updating-data)
	- [Intercepting Routes](/docs/app/api-reference/file-conventions/intercepting-routes)

	Attempting to use any of these features with `next dev` will result in an error, similar to setting the [`dynamic`](/docs/app/api-reference/file-conventions/route-segment-config#dynamic) option to `error` in the root layout.

	```jsx
	export const dynamic = 'error'
	```

	</AppOnly>

	<PagesOnly>

	- [Internationalized Routing](/docs/pages/guides/internationalization)
	- [API Routes](/docs/pages/building-your-application/routing/api-routes)
	- [Rewrites](/docs/pages/api-reference/config/next-config-js/rewrites)
	- [Redirects](/docs/pages/api-reference/config/next-config-js/redirects)
	- [Headers](/docs/pages/api-reference/config/next-config-js/headers)
	- [Middleware](/docs/pages/api-reference/file-conventions/middleware)
	- [Incremental Static Regeneration](/docs/pages/guides/incremental-static-regeneration)
	- [Image Optimization](/docs/pages/api-reference/components/image) with the default `loader`
	- [Draft Mode](/docs/pages/guides/draft-mode)
	- [`getStaticPaths` with `fallback: true`](/docs/pages/api-reference/functions/get-static-paths#fallback-true)
	- [`getStaticPaths` with `fallback: 'blocking'`](/docs/pages/api-reference/functions/get-static-paths#fallback-blocking)
	- [`getServerSideProps`](/docs/pages/building-your-application/data-fetching/get-server-side-props)

	</PagesOnly>

	## Deploying

	With a static export, Next.js can be deployed and hosted on any web server that can serve HTML/CSS/JS static assets.

	When running `next build`, Next.js generates the static export into the `out` folder. For example, let's say you have the following routes:

	- `/`
	- `/blog/[id]`

	After running `next build`, Next.js will generate the following files:

	- `/out/index.html`
	- `/out/404.html`
	- `/out/blog/post-1.html`
	- `/out/blog/post-2.html`

	If you are using a static host like Nginx, you can configure rewrites from incoming requests to the correct files:

	```nginx filename="nginx.conf"
	server {
	listen 80;
	server_name acme.com;

	root /var/www/out;

	location / {
	try_files $uri $uri.html $uri/ =404;
	}

	# This is necessary when `trailingSlash: false`.
	# You can omit this when `trailingSlash: true`.
	location /blog/ {
	rewrite ^/blog/(.*)$ /blog/$1.html break;
	}

	error_page 404 /404.html;
	location = /404.html {
	internal;
	}
	}
	```

	## Version History

	\| Version \| Changes \|
	\| --------- \| -------------------------------------------------------------------------------------------------------------------- \|
	\| `v14.0.0` \| `next export` has been removed in favor of `"output": "export"` \|
	\| `v13.4.0` \| App Router (Stable) adds enhanced static export support, including using React Server Components and Route Handlers. \|
	\| `v13.3.0` \| `next export` is deprecated and replaced with `"output": "export"` \|