Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add clarity in docs for using exportPathMap with getStaticPaths #39813

Merged
merged 2 commits into from Aug 22, 2022
Merged

Add clarity in docs for using exportPathMap with getStaticPaths #39813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34b66f1
Add clarity in docs for using exportPathMap with getStaticPaths
MaedahBatool Aug 22, 2022
476fdc7
Merge branch 'canary' into epm-vs-gsp
ijjk Aug 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/advanced-features/static-html-export.md
View file
Open in desktop
Expand Up @@ -31,6 +31,8 @@ Running `npm run build` will generate an `out` directory.

For more advanced scenarios, you can define a parameter called [`exportPathMap`](/docs/api-reference/next.config.js/exportPathMap.md) in your [`next.config.js`](/docs/api-reference/next.config.js/introduction.md) file to configure exactly which pages will be generated.

> **Warning**: Using `exportPathMap` for defining routes with any `getStaticPaths` powered page is now ignored and gets overridden. We recommend not to use them together.

## Supported Features

The majority of core Next.js features needed to build a static site are supported, including:
Expand Down
4 changes: 3 additions & 1 deletion docs/api-reference/next.config.js/exportPathMap.md
View file
Open in desktop
Expand Up @@ -40,7 +40,7 @@ module.exports = {
}
```

Note: the `query` field in `exportPathMap` cannot be used with [automatically statically optimized pages](/docs/advanced-features/automatic-static-optimization) or [`getStaticProps` pages](/docs/basic-features/data-fetching/get-static-props.md) as they are rendered to HTML files at build-time and additional query information cannot be provided during `next export`.
> Note: the `query` field in `exportPathMap` cannot be used with [automatically statically optimized pages](/docs/advanced-features/automatic-static-optimization) or [`getStaticProps` pages](/docs/basic-features/data-fetching/get-static-props.md) as they are rendered to HTML files at build-time and additional query information cannot be provided during `next export`.

The pages will then be exported as HTML files, for example, `/about` will become `/about.html`.

Expand Down Expand Up @@ -79,6 +79,8 @@ module.exports = {
next export -o outdir
```

> **Warning**: Using `exportPathMap` for defining routes with any `getStaticPaths` powered page is now ignored and gets overridden. We recommend not to use them together.
Copy link
Member

@leerob leerob Aug 23, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"is now ignored" – what changed and at what version? If we don't recommend to use together, can we provide more clarity?

Note: If you are using getStaticPaths to define routes, you should not use exportPathMap.

Is it this or something else?


## Related

<div class="card">
Expand Down