34e9409770
[Docs] Update next.config.js link to default config ( #22989 )
...
It's currently misleading and I chose to freeze to a particular version since pointing to canary every time is likely to break (as is happening prior to this PR).
The link will now go to: https://github.com/vercel/next.js/blob/v10.0.8/packages/next/next-server/server/config-shared.ts#L33
2021-03-17 20:21:39 +00:00
f3cbdf0b02
Document how to use basePath with next/image. ( #23123 )
...
Supersedes https://github.com/vercel/next.js/pull/23115 for more clarity and a better recommendation.
2021-03-16 19:56:41 +00:00
308c2beca2
Add image base path configuration option ( #23115 )
...
I similarly [couldn't find this info](https://github.com/vercel/next.js/issues/19711#issuecomment-750414110 ) in the docs about configuring the image path when using an app `basePath`, so thought I'd add it.
2021-03-16 17:13:24 +00:00
e36eb381da
Duplicate scroll description ( #23103 )
...
- `scroll` - Optional boolean, controls scrolling to the top of the page after navigation. Defaults to `true` and
- `scroll`: Scroll to the top of the page after a navigation. Defaults to `true`
as options for router.push
2021-03-16 16:39:14 +00:00
9431439c6d
Add note about next/export to Image Optimization docs. ( #23088 )
...
https://github.com/vercel/next.js/discussions/19065#discussioncomment-484842
2021-03-16 01:05:14 +00:00
3063d3b8ff
Update pages.md ( #23064 )
...
The `path` variable must be an array of objects which has a `params` key. This code will prevent reader confusion.
2021-03-15 02:44:58 +00:00
2af5a0e47c
it is props: { posts } ( #23004 )
...
changing `props: posts` to `props: { posts }`
2021-03-12 08:11:01 +00:00
e7a22afe2f
When there is data already, the props is props: { data } ( #23003 )
...
When there is data already, the props is props: { data }
Would be better if the `props: { }` part is `props: { data }`
2021-03-12 08:03:10 +00:00
62967fc667
Add note for loading env files during testing ( #22982 )
...
This adds a note to the environment variables documentation to mention how the env files can be loaded using the `@next/env` package as this has been brought up a few times.
x-ref: https://github.com/vercel/next.js/issues/22936#issuecomment-796665303
x-ref: https://github.com/vercel/next.js/issues/17903
2021-03-12 00:47:42 +00:00
fa02b197f5
Fix typo in source maps documentation. ( #22952 )
2021-03-10 16:41:01 +00:00
e9a1d8fd42
Add documentation for new static 500 behavior ( #22888 )
...
Co-authored-by: Tim Neutkens <tim@timneutkens.nl >
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-03-09 12:45:31 +01:00
635a98e2fd
Fix typo ( #22891 )
...
This PR fixed a typo in api reference.
2021-03-09 01:37:52 +00:00
81b05256dd
Update router.md ( #21899 )
...
include scroll option documentation for router.push
2021-03-08 13:52:37 +00:00
87ccebf5fd
Update module-path-aliases.md ( #22739 )
...
Add note about restarting dev server on changes to tsconfig / jsconfig
2021-03-08 14:19:31 +01:00
ce400b2678
Update NEXT_LOCALE cookie note ( #22736 )
...
This updates the `NEXT_LOCALE` cookie docs to mention how it is used for redirecting from `/` more specifically.
x-ref: https://github.com/vercel/next.js/pull/20045#discussion_r586158535
2021-03-03 19:30:01 +00:00
006eba3225
Add note for using getStaticProps with 404.js ( #22693 )
...
Help clarify that this option is available!
2021-03-02 17:09:54 +00:00
b874bc7f82
Add note about preloading to routing introduction. ( #22656 )
...
Preloading is mentioned in the `next/link` docs, but not in the routing introduction.
2021-03-02 03:17:43 +00:00
5b0ed99093
Fix grammar in next/amp API reference ( #22653 )
...
Change 'an' of "The page has an user-accessible" to 'a'.
2021-03-02 00:33:09 +00:00
86ce29b34a
Update authentication.md SSR example ( #22641 )
...
There are two examples, one (a) for "Authenticating Statically Generated Pages" and one (b) for "Authenticating Server-Rendered Pages".
(a) uses a sudo `useUser` hook to fetch the user client-side.
It looks like the example for (b) was copied and pasted then edited from (a), but in (b) this `useUser` hook is not used (instead using `req.session.get('user')`).
This PR simply removes the unused import in the (b) example.
2021-03-01 16:44:32 +00:00
eb79218b7d
Add note about other redirects to next.config.js docs. ( #22640 )
...
In case a user lands on this page via search or from Google, we should mention the other ways you can redirect with Next.js.
2021-03-01 16:33:04 +00:00
293c243ab7
add-supertokens-to-authentication.md ( #22223 )
...
Hey team. This PR is a follow up on https://github.com/vercel/next.js/pull/21384 to add a reference to `with-supertokens` example to authentication doc.
2021-03-01 15:53:17 +00:00
0a35b578d4
Add use cases for API Routes to documentation. ( #22616 )
...
I've seen this confusion come up a few times, specifically [here](https://www.reddit.com/r/nextjs/comments/lsmpon/is_there_a_benefit_to_using_api_when_you_are_only/ ) for the latest.
2021-03-01 01:15:14 +00:00
a289d38057
Simplify code examples for dynamic API routes ( #22546 )
...
Deep matching destructuring syntax is hard to understand and read vs. `const { ... } = req.query`.
2021-02-26 18:43:41 +00:00
1ba5c0acc7
Add link to TypeScript docs from API Routes section ( #22564 )
2021-02-26 13:39:16 +00:00
69fe678ea9
docs(deployment): Update user ownership in docker deployment docs ( #22539 )
...
After testing the new docker deployment documentation, ran into the following error when running the container if you're using `next/image`:
```
[Error: EACCES: permission denied, unlink '/app/.next/cache/images/2+fKe4RlpMaSTNc8npKwiCItZgik9aOX9qkxnVSrsUo=/1613616499089.3hEMhfux5+SolMDEVHEaVPK2O0OlcLoYNao0yKpmYeg=.webp'] {
errno: -13,
code: 'EACCES',
syscall: 'unlink',
path: '/app/.next/cache/images/2+fKe4RlpMaSTNc8npKwiCItZgik9aOX9qkxnVSrsUo=/1613616499089.3hEMhfux5+SolMDEVHEaVPK2O0OlcLoYNao0yKpmYeg=.webp'
}
```
This change gives the user correct ownership to have the correct permissions.
2021-02-25 17:16:10 +00:00
d9bb645c03
Mention regex route behavior with i18n ( #22500 )
...
This mentions how locale routes are transformed when `locale: false` is not used to explain why regex routes might not match with i18n.
Closes: https://github.com/vercel/next.js/issues/21507
2021-02-24 19:04:30 +00:00
460c7c7ddc
Update deployment docs to mention caveat on next.config.js. ( #22480 )
2021-02-24 04:21:43 +00:00
e5bc0cdae0
docs(deployment): Update working directory in builder stage ( #22478 )
...
Update docker file example in deploy documentation to use correct working directory in builder stage. It will fail to copy files from that stage since it's attempting to copy files that don't exist.
2021-02-24 03:52:36 +00:00
1253a11971
docs(deployment): Add Docker Image section ( #17794 )
...
Add a Docker Image section into the Deployment Documentation with an example and how to build and run it.
The example is a multi-stage docker image with node modules layer caching for faster builds in development and a result image just with the node_modules and build code needed to run the application within a custom user with restricted access.
The example contains a commented piece of code on how to disable telemetry as well.
This is useful for folks that are deploying to container orchestrators like ECS, Kubernetes (GKE, EKS, AKS) or Hashicorp Nomad, as well as just running a docker container in a single node in some cloud provider.
2021-02-24 00:42:15 +00:00
fea5c18132
Update docs. ( #22358 )
2021-02-20 00:49:41 +00:00
9793e9004f
Add isPreview field to router ( #21638 )
...
This adds an `isPreview` field to the `next/router` to allow detecting when in preview mode.
Closes: https://github.com/vercel/next.js/issues/14903
2021-02-18 18:34:33 +00:00
6af69793aa
Point to official next-auth example ( #22282 )
...
We would like to maintain a single `next-auth` example under our organization. This PR points readers of the Next.js docs to our repository, instead of `with-next-auth`
Also, as @kriscarle pointed out in https://github.com/nextauthjs/next-auth/issues/1132#issuecomment-772375650 , we should maybe only maintain a single example to be able to keep it up-to-date more easily.
2021-02-18 15:39:38 +00:00
1c3ac0e3eb
Document scroll option for router.push ( #22275 )
...
Clarify in the docs that scroll is an option for router.push() and it defaults to true.
2021-02-17 16:02:18 +00:00
958bd6cabb
Update server output path in static optimization docs ( #21910 )
2021-02-05 21:00:03 -06:00
ee184a11d8
Add example for headers and link in the docs ( #21821 )
2021-02-05 09:07:22 -06:00
cef4b4b153
Revert "Fix docs for sample query parameters" ( #21881 )
...
This reverts commit 9a3a0da319
2021-02-04 20:35:09 -05:00
9a3a0da319
Fix docs for sample query parameters ( #21879 )
2021-02-05 01:17:26 +00:00
40065135a5
Docs: delete extra bracket [introduction.md] ( #21715 )
2021-02-01 06:24:10 +00:00
e2001db016
Fix “it’s” typo in CRA migration doc ( #21678 )
2021-01-29 20:58:11 -06:00
232209b513
Remove note about Yarn 2 support. ( #21665 )
...
My addition of the Yarn 2 caveat was more nuanced than I thought. Apologies. @merceyz has been adding extensive e2e tests for Yarn 2 support. We plan to support Yarn 2 compat.
Reverts https://github.com/vercel/next.js/pull/21657 .
2021-01-29 19:09:17 +00:00
843252b821
Add note about Yarn 2 support. ( #21657 )
...
As we saw some confusion with users trying out Yarn 2 and hitting roadblocks in their app. Yarn 2 is supported on a best-effort basis.
2021-01-29 14:38:19 +00:00
5a73859fe8
Update docs and Create Next App to use API Middlewares by default. ( #21639 )
2021-01-28 23:34:03 +00:00
7aa397f32e
Add Kontent example to preview section ( #21542 )
...
Kontent example also contains the implementation of the preview capabilities in the example.
Including the example as it is [Data fetching section](https://nextjs.org/docs/basic-features/data-fetching ).
2021-01-26 15:00:29 +00:00
c619f41f92
Doc: pageExtensions - note regarding affected files ( #21326 )
...
#21279
This is just a comment explaining that changing `pageExtensions` not only applies to `pages/*` but other files as well.
2021-01-26 11:49:36 +00:00
d82672c397
Add Next.js Analytics to documentation. ( #21527 )
2021-01-25 19:12:33 +00:00
6c51ad96ac
Added Typescript example for withRouter ( #18116 )
...
Co-authored-by: Tim Neutkens <tim@timneutkens.nl >
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-01-25 14:48:28 +01:00
8d92010979
Update headers.md to clarify Cache-Control gets overwritten in prod ( #19967 )
...
Co-authored-by: Tim Neutkens <timneutkens@me.com >
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2021-01-24 17:14:19 +01:00
5baedf5567
Update data-fetching.md to use async file loading ( #17518 )
...
Co-authored-by: Tim Neutkens <timneutkens@me.com >
2021-01-23 17:28:33 +01:00
d991e3c957
Update manifest.json
2021-01-21 15:06:53 +01:00
0fc46d0b70
Add Note to i18n-routing Docs for Subdomains for Locale Domains ( #21387 )
2021-01-20 17:08:55 +00:00
Josh Flayhart