diff --git a/docs/advanced-features/amp-support/adding-amp-components.md b/docs/advanced-features/amp-support/adding-amp-components.md index 8ecd294025f05c8f34dac39c62f7c04e2e6f0b68..1c11ffe8c630c2809f913ce8cefbef4a42fab78e 100644 --- a/docs/advanced-features/amp-support/adding-amp-components.md +++ b/docs/advanced-features/amp-support/adding-amp-components.md @@ -1,3 +1,7 @@ +--- +description: Add components from the AMP community to AMP pages, and make your pages more interactive. +--- + # Adding AMP Components The AMP community provide [many components](https://amp.dev/documentation/components/) to make AMP pages more interactive. You can add these components to your page by using `next/head`, as in the following example: diff --git a/docs/advanced-features/amp-support/amp-in-static-html-export.md b/docs/advanced-features/amp-support/amp-in-static-html-export.md index f6372f481eaeb24636f0ae7a2cc365e9b9103db7..dfa3afbc41f309c15154227b131e97a507a3f6d2 100644 --- a/docs/advanced-features/amp-support/amp-in-static-html-export.md +++ b/docs/advanced-features/amp-support/amp-in-static-html-export.md @@ -1,3 +1,7 @@ +--- +description: Learn how AMP pages are created when used together with `next export`. +--- + # AMP in Static HTML export When using `next export` to do [Static HTML export](/docs/advanced-features/static-html-export.md) statically prerender pages, Next.js will detect if the page supports AMP and change the exporting behavior based on that. diff --git a/docs/advanced-features/amp-support/amp-validation.md b/docs/advanced-features/amp-support/amp-validation.md index ac22bd5a337b388b50486a1e43f75cc368c739db..85902433071233900f6d945ef0715672e7d15876 100644 --- a/docs/advanced-features/amp-support/amp-validation.md +++ b/docs/advanced-features/amp-support/amp-validation.md @@ -1,3 +1,7 @@ +--- +description: AMP pages are automatically validated by Next.js during development and on build. Learn more about it here. +--- + # AMP Validation AMP pages are automatically validated with [amphtml-validator](https://www.npmjs.com/package/amphtml-validator) during development. Errors and warnings will appear in the terminal where you started Next.js. diff --git a/docs/advanced-features/amp-support/introduction.md b/docs/advanced-features/amp-support/introduction.md index 2b87e3f33bbf7748d07e5a27feb899e41e7afc6c..187445004764951e08c8b727ae003552cf5d3338 100644 --- a/docs/advanced-features/amp-support/introduction.md +++ b/docs/advanced-features/amp-support/introduction.md @@ -1,3 +1,7 @@ +--- +description: With minimal config, and without leaving React, you can start adding AMP and improve the performance and speed of your pages. +--- + # AMP Support
diff --git a/docs/advanced-features/amp-support/typescript.md b/docs/advanced-features/amp-support/typescript.md index c9d794c2a5805567383b25de91451d0505e94832..273c943d94920f3e766885b84ec2fbce94cfb2d5 100644 --- a/docs/advanced-features/amp-support/typescript.md +++ b/docs/advanced-features/amp-support/typescript.md @@ -1,3 +1,7 @@ +--- +description: Using AMP with TypeScript? Extend your typings to allow AMP components. +--- + # TypeScript AMP currently doesn't have built-in types for TypeScript, but it's in their roadmap ([#13791](https://github.com/ampproject/amphtml/issues/13791)). diff --git a/docs/advanced-features/automatic-static-optimization.md b/docs/advanced-features/automatic-static-optimization.md index 0aa01b8b25121e846465abcc478deaf37be3570b..c3304ed843a05c6b19ef2b5e3c06538629168227 100644 --- a/docs/advanced-features/automatic-static-optimization.md +++ b/docs/advanced-features/automatic-static-optimization.md @@ -1,3 +1,7 @@ +--- +description: Next.js automatically optimizes your app to be static HTML whenever possible. Learn how it works here. +--- + # Automatic Static Optimization Next.js automatically determines that a page is static (can be prerendered) if it has no blocking data requirements. This determination is made by the absence of `getInitialProps` in the page. diff --git a/docs/advanced-features/custom-app.md b/docs/advanced-features/custom-app.md index 0b920c575c3cf8ab1ddf3467b26e80326abc2b4c..22095d635aca23ad81404aa46d0503c02fbb51c2 100644 --- a/docs/advanced-features/custom-app.md +++ b/docs/advanced-features/custom-app.md @@ -1,3 +1,7 @@ +--- +description: Control page initialization and add a layout that persists for all pages by overriding the default App component used by Next.js. +--- + # Custom `App` Next.js uses the `App` component to initialize pages. You can override it and control the page initialization. Which allows you to do amazing things like: diff --git a/docs/advanced-features/custom-document.md b/docs/advanced-features/custom-document.md index 5e1c9890b96345044b25eb01f2c43f03b9fbf4a3..4408cf087f95fb47ab5e1a8b3e3b8d72e257971d 100644 --- a/docs/advanced-features/custom-document.md +++ b/docs/advanced-features/custom-document.md @@ -1,3 +1,7 @@ +--- +description: Extend the default document markup added by Next.js. +--- + # Custom `Document` A custom `Document` is commonly used to augment your application's `` and `` tags. This is necessary because Next.js pages skip the definition of the surrounding document's markup. diff --git a/docs/advanced-features/custom-error-page.md b/docs/advanced-features/custom-error-page.md index 80279ee19b3c83e74e435cdef65a0bc4287d5125..828ecf789a23606eedde6b517080f93f382c8d0a 100644 --- a/docs/advanced-features/custom-error-page.md +++ b/docs/advanced-features/custom-error-page.md @@ -1,3 +1,7 @@ +--- +description: Override and extend the built-in Error page to handle custom errors. +--- + # Custom Error Page **404** or **500** errors are handled both client-side and server-side by the `Error` component. If you wish to override it, define the file `pages/_error.js` and add the following code: diff --git a/docs/advanced-features/custom-server.md b/docs/advanced-features/custom-server.md index 824a2393bc480b2404c6d6a595cc4b4c5cbbe213..7b1ae1bdc22f1fd7eef21407321b436fac83ef1e 100644 --- a/docs/advanced-features/custom-server.md +++ b/docs/advanced-features/custom-server.md @@ -1,3 +1,7 @@ +--- +description: Start a Next.js app programmatically using a custom server. +--- + # Custom Server
diff --git a/docs/advanced-features/customizing-babel-config.md b/docs/advanced-features/customizing-babel-config.md index 4e2b33cc977e37a61192a53d4ee080f5e79f2872..8bdf25a48cd971d4f221a905729cc7d904984753 100644 --- a/docs/advanced-features/customizing-babel-config.md +++ b/docs/advanced-features/customizing-babel-config.md @@ -1,3 +1,7 @@ +--- +description: Extend the babel preset added by Next.js with your own configs. +--- + # Customizing Babel Config
diff --git a/docs/advanced-features/dynamic-import.md b/docs/advanced-features/dynamic-import.md index b957d886cbf704cae0ff50b0af629d9d677bcdc5..adf716f1501b23ccbe9e2bef7c539f8b089e6241 100644 --- a/docs/advanced-features/dynamic-import.md +++ b/docs/advanced-features/dynamic-import.md @@ -1,3 +1,7 @@ +--- +description: Dynamically import JavaScript modules and React Components and split your code into manageable chunks. +--- + # Dynamic Import
diff --git a/docs/advanced-features/src-directory.md b/docs/advanced-features/src-directory.md index 048d14b40a92ab5e3311f61bb3f8f32832d4c40f..00a16283238271968ec3335272b58c2b60f81855 100644 --- a/docs/advanced-features/src-directory.md +++ b/docs/advanced-features/src-directory.md @@ -1,3 +1,7 @@ +--- +description: Save pages under the `src` directory as an alternative to the root `pages` directory. +--- + # `src` Directory Pages can also be added under `src/pages` as an alternative to the root `pages` directory. diff --git a/docs/advanced-features/static-html-export.md b/docs/advanced-features/static-html-export.md index 62417c64ede16909f6d5f8907c94325079f065ef..86922903cc89575bce8c2b7bf5615ecbac45a278 100644 --- a/docs/advanced-features/static-html-export.md +++ b/docs/advanced-features/static-html-export.md @@ -1,3 +1,7 @@ +--- +description: Export your Next.js app to static HTML, and run it standalone without the need of a Node.js server. +--- + # Static HTML Export
diff --git a/docs/api-reference/cli.md b/docs/api-reference/cli.md index 1774f5870611b80c12ed68578a94bc4002b8bf64..da3660a75e1cc9ad7fa5389d3e8f40a16f8125b7 100644 --- a/docs/api-reference/cli.md +++ b/docs/api-reference/cli.md @@ -1,3 +1,7 @@ +--- +description: The Next.js CLI allows you to start, build, and export your application. Learn more about it here. +--- + # Next.js CLI The Next.js CLI allows you to start, build, and export your application. diff --git a/docs/api-reference/data-fetching/getInitialProps.md b/docs/api-reference/data-fetching/getInitialProps.md index f38c3aa309f157e6c79dfe39658313ba420456d1..122ffe288804d1d73e366c31502b91013b4f19b9 100644 --- a/docs/api-reference/data-fetching/getInitialProps.md +++ b/docs/api-reference/data-fetching/getInitialProps.md @@ -1,3 +1,7 @@ +--- +description: Enable Server-Side Rendering in a page and do initial data population with `getInitialProps`. +--- + # getInitialProps
diff --git a/docs/api-reference/next.config.js/build-target.md b/docs/api-reference/next.config.js/build-target.md index c55da8adeec47971b07a0f3c5d6ba485a1d405c9..06651ebf01d3b1f90120d91b4010ff20b09477c5 100644 --- a/docs/api-reference/next.config.js/build-target.md +++ b/docs/api-reference/next.config.js/build-target.md @@ -1,3 +1,7 @@ +--- +description: Learn more about the build targets used by Next.js, which decide the way your application is built and run. +--- + # Build Target Next.js supports various build targets, each changing the way your application is built and run. We'll explain each of the targets below. diff --git a/docs/api-reference/next.config.js/cdn-support-with-asset-prefix.md b/docs/api-reference/next.config.js/cdn-support-with-asset-prefix.md index ba1ced8b1cea45a1500d7e4f4f6a31168985d41d..c08b9ab21900be61ce520ec9f8ebe24506a3c80c 100644 --- a/docs/api-reference/next.config.js/cdn-support-with-asset-prefix.md +++ b/docs/api-reference/next.config.js/cdn-support-with-asset-prefix.md @@ -1,3 +1,7 @@ +--- +description: A custom asset prefix allows you serve static assets from a CDN. Learn more about it here. +--- + # CDN Support with Asset Prefix To set up a [CDN](https://en.wikipedia.org/wiki/Content_delivery_network), you can set up an asset prefix and configure your CDN's origin to resolve to the domain that Next.js is hosted on. diff --git a/docs/api-reference/next.config.js/compression.md b/docs/api-reference/next.config.js/compression.md index 87a9da4d88ebe21d343ba8523440f0ff0ee1ddf8..9f98132b1a4a659c93a096bca2de234f8f505959 100644 --- a/docs/api-reference/next.config.js/compression.md +++ b/docs/api-reference/next.config.js/compression.md @@ -1,3 +1,7 @@ +--- +description: Next.js provides gzip compression to compress rendered content and static files, it only works with the server target. Learn more about it here. +--- + # Compression Next.js provides [**gzip**](https://tools.ietf.org/html/rfc6713#section-3) compression to compress rendered content and static files. Compression only works with the [`server` target](/docs/api-reference/next.config.js/build-target.md#server-target). In general you will want to enable compression on a HTTP proxy like [nginx](https://www.nginx.com/), to offload load from the `Node.js` process. diff --git a/docs/api-reference/next.config.js/configuring-onDemandEntries.md b/docs/api-reference/next.config.js/configuring-onDemandEntries.md index a12c94e4ef9cfa549c222b3ad38303563dd767bb..8b05d1c5801ca4bb6e7f292218ec97b8543701ce 100644 --- a/docs/api-reference/next.config.js/configuring-onDemandEntries.md +++ b/docs/api-reference/next.config.js/configuring-onDemandEntries.md @@ -1,3 +1,7 @@ +--- +description: Configure how Next.js will dispose and keep in memory pages created in development. +--- + # Configuring onDemandEntries Next.js exposes some options that give you some control over how the server will dispose or keep in memory built pages in development. diff --git a/docs/api-reference/next.config.js/configuring-the-build-id.md b/docs/api-reference/next.config.js/configuring-the-build-id.md index 4f5eb33ce1dc279cf45d7f3ff50048640ffd7b01..ede037ff20f511bae13ec97282ffba9366eb0d65 100644 --- a/docs/api-reference/next.config.js/configuring-the-build-id.md +++ b/docs/api-reference/next.config.js/configuring-the-build-id.md @@ -1,3 +1,7 @@ +--- +description: Configure the build id, which is used to identify the current build in which your application is being served. +--- + # Configuring the Build ID Next.js uses a constant id generated at build time to identify which version of your application is being served. This can cause problems in multi-server deployments when `next build` is ran on every server. In order to keep a static build id between builds you can provide your own build id. diff --git a/docs/api-reference/next.config.js/custom-page-extensions.md b/docs/api-reference/next.config.js/custom-page-extensions.md index f7f1ef067acc65fe1919d6af07ed5d90fdb60a2e..bdec8334e9cc3ef8317b318d93c6d035e87112e5 100644 --- a/docs/api-reference/next.config.js/custom-page-extensions.md +++ b/docs/api-reference/next.config.js/custom-page-extensions.md @@ -1,3 +1,7 @@ +--- +description: Extend the default page extensions used by Next.js when resolving pages in the pages directory. +--- + # Custom Page Extensions Aimed at modules like [@next/mdx](https://github.com/zeit/next.js/tree/canary/packages/next-mdx), which adds support for pages ending with `.mdx`. You can configure the extensions looked for in the `pages` directory when resolving pages. diff --git a/docs/api-reference/next.config.js/custom-webpack-config.md b/docs/api-reference/next.config.js/custom-webpack-config.md index 6cecace2221c3e87477df1a4747e57b76b68b5ce..e3dd4af69c5f6515aa49991277d53ff12d84914f 100644 --- a/docs/api-reference/next.config.js/custom-webpack-config.md +++ b/docs/api-reference/next.config.js/custom-webpack-config.md @@ -1,3 +1,7 @@ +--- +description: Extend the default webpack config added by Next.js. +--- + # Custom Webpack Config Some commonly asked for features are available as plugins: diff --git a/docs/api-reference/next.config.js/disabling-etag-generation.md b/docs/api-reference/next.config.js/disabling-etag-generation.md index 89329369539d72e345759096470c130950039d08..27ecf6660d81be29feda0c57af561503b302ae59 100644 --- a/docs/api-reference/next.config.js/disabling-etag-generation.md +++ b/docs/api-reference/next.config.js/disabling-etag-generation.md @@ -1,3 +1,7 @@ +--- +description: Next.js will generate etags for every page by default. Learn more about how to disable etag generation here. +--- + # Disabling ETag Generation Next.js will generate [etags](https://en.wikipedia.org/wiki/HTTP_ETag) for every page by default. You may want to disable etag generation for HTML pages depending on your cache strategy. diff --git a/docs/api-reference/next.config.js/disabling-x-powered-by.md b/docs/api-reference/next.config.js/disabling-x-powered-by.md index cfcd4bd569d1289f847027338b812949c58d6112..a6d3db934f58eff84649d553d867f8040638f459 100644 --- a/docs/api-reference/next.config.js/disabling-x-powered-by.md +++ b/docs/api-reference/next.config.js/disabling-x-powered-by.md @@ -1,3 +1,7 @@ +--- +description: Next.js will add `x-powered-by` to the request headers by default. Learn to opt-out of it here. +--- + # Disabling x-powered-by By default Next.js will add `x-powered-by` to the request headers. To opt-out of it, open `next.config.js` and disable the `poweredByHeader` config: diff --git a/docs/api-reference/next.config.js/environment-variables.md b/docs/api-reference/next.config.js/environment-variables.md index c8d427fc4681c9349d445d76f9dc2f8613b73b7d..4bd74196f8b358e224d8f23dc9ac97500883a32a 100644 --- a/docs/api-reference/next.config.js/environment-variables.md +++ b/docs/api-reference/next.config.js/environment-variables.md @@ -1,3 +1,7 @@ +--- +description: Learn to add and access environment variables in your Next.js application at build time. +--- + # Environment Variables
diff --git a/docs/api-reference/next.config.js/exportPathMap.md b/docs/api-reference/next.config.js/exportPathMap.md index 9d9b3ae509ee7f6427e6778395393c58b4ddfa42..bf367d6b31b86a96ad3a9f33d9356d3a654c5a34 100644 --- a/docs/api-reference/next.config.js/exportPathMap.md +++ b/docs/api-reference/next.config.js/exportPathMap.md @@ -1,3 +1,7 @@ +--- +description: Customize the pages that will be exported as HTML files when using `next export`. +--- + # exportPathMap > This feature is exclusive of `next export`. Please refer to [Static HTML export](/docs/advanced-features/static-html-export.md) if you want to learn more about it. diff --git a/docs/api-reference/next.config.js/ignoring-typescript-errors.md b/docs/api-reference/next.config.js/ignoring-typescript-errors.md index 28b45ef8b7033cce52d267b255e472fcf3eb9607..bde16ed256ee3629fb890b517b97259ed9cd2f6e 100644 --- a/docs/api-reference/next.config.js/ignoring-typescript-errors.md +++ b/docs/api-reference/next.config.js/ignoring-typescript-errors.md @@ -1,3 +1,7 @@ +--- +description: Next.js reports TypeScript errors by default. Learn to opt-out of this behavior here. +--- + # Ignoring TypeScript Errors Next.js reports TypeScript errors by default. If you don't want to leverage this behavior and prefer something else instead, like your editor's integration, you may want to disable it. diff --git a/docs/api-reference/next.config.js/introduction.md b/docs/api-reference/next.config.js/introduction.md index a4af3c1cb643d1bf3b68dae919bd89fe361b1bcf..e9fd3f681694fb0f97fd53f280f56a0dad3d4b71 100644 --- a/docs/api-reference/next.config.js/introduction.md +++ b/docs/api-reference/next.config.js/introduction.md @@ -1,3 +1,7 @@ +--- +description: learn more about the configuration file used by Next.js to handle your application. +--- + # next.config.js For custom advanced behavior of Next.js, you can create a `next.config.js` in the root of your project directory (next to `package.json`). diff --git a/docs/api-reference/next.config.js/runtime-configuration.md b/docs/api-reference/next.config.js/runtime-configuration.md index 4880d9bb28402feb426c2230a359f92f2874caad..b176acbb5e361896f194e28df66e6027129b883c 100644 --- a/docs/api-reference/next.config.js/runtime-configuration.md +++ b/docs/api-reference/next.config.js/runtime-configuration.md @@ -1,3 +1,7 @@ +--- +description: Add client and server runtime configuration to your Next.js app. +--- + # Runtime Configuration > Generally you'll want to use [build-time environment variables](/docs/api-reference/next.config.js/environment-variables.md) to provide your configuration. The reason for this is that runtime configuration adds rendering / initialization overhead and is incompatible with [Automatic Static Optimization](/docs/advanced-features/automatic-static-optimization.md). diff --git a/docs/api-reference/next.config.js/setting-a-custom-build-directory.md b/docs/api-reference/next.config.js/setting-a-custom-build-directory.md index fea342c406a3f100828a245f2cb5fed8c177eab1..df5113ab88a48e3e075c0800bd3ffd63a32850e8 100644 --- a/docs/api-reference/next.config.js/setting-a-custom-build-directory.md +++ b/docs/api-reference/next.config.js/setting-a-custom-build-directory.md @@ -1,3 +1,7 @@ +--- +description: Set a custom build directory to use instead of the default .next directory. +--- + # Setting a custom build directory You can specify a name to use for a custom build directory to use instead of `.next`. diff --git a/docs/api-reference/next.config.js/static-optimization-indicator.md b/docs/api-reference/next.config.js/static-optimization-indicator.md index a74d9f96bbc6c0339167b555ec5f89873b11aaa7..92ec75b66826a1b937cb1cc74d09ed364bcfe98d 100644 --- a/docs/api-reference/next.config.js/static-optimization-indicator.md +++ b/docs/api-reference/next.config.js/static-optimization-indicator.md @@ -1,3 +1,7 @@ +--- +description: Optimized pages include an indicator to let you know if it's being statically optimized. You can opt-out of it here. +--- + # Static Optimization Indicator When a page qualifies for [Automatic Static Optimization](/docs/advanced-features/automatic-static-optimization.md) we show an indicator to let you know. diff --git a/docs/api-reference/next/amp.md b/docs/api-reference/next/amp.md index 5549281d97b9d157130c97dad6a93f1aec218dfc..a5fd080b2fd5d959cc455f6d50318094fcc2340d 100644 --- a/docs/api-reference/next/amp.md +++ b/docs/api-reference/next/amp.md @@ -1,3 +1,7 @@ +--- +description: Enable AMP in a page, and control the way Next.js adds AMP to the page with the AMP config. +--- + # next/amp
diff --git a/docs/api-reference/next/head.md b/docs/api-reference/next/head.md index e083bd1cc60c9a4a0f3de95f9522a39c66f882f1..802e7563b995d0d25d197213cb2779ca6249f84b 100644 --- a/docs/api-reference/next/head.md +++ b/docs/api-reference/next/head.md @@ -1,3 +1,7 @@ +--- +description: Add custom elements to the `head` of your page with the built-in Head component. +--- + # next/head
diff --git a/docs/api-reference/next/link.md b/docs/api-reference/next/link.md index beaec48640ea9c2a2c263407d03d65404dee34d6..560ae5c48c9ba7b23dc33a76c8d93d0e88820991 100644 --- a/docs/api-reference/next/link.md +++ b/docs/api-reference/next/link.md @@ -1,3 +1,7 @@ +--- +description: Enable client-side transitions between routes with the built-in Link component. +--- + # next/link
diff --git a/docs/api-reference/next/router.md b/docs/api-reference/next/router.md index e2a3be541e63f47fdd23fc78df4619375d8337dc..0238ef674110b420464294bd18fa8fcac62f3f3e 100644 --- a/docs/api-reference/next/router.md +++ b/docs/api-reference/next/router.md @@ -1,3 +1,7 @@ +--- +description: Learn more about the API of the Next.js Router, and access the router instance in your page with the useRouter hook. +--- + # next/router > Before moving forward, we recommend you to read [Routing Introduction](/docs/routing/introduction.md) first. diff --git a/docs/api-routes/api-middlewares.md b/docs/api-routes/api-middlewares.md index 99c27971d9632ccc718d0e7a38757cee7942fd1b..431e687ac01f220ba899810f293d68f82479d100 100644 --- a/docs/api-routes/api-middlewares.md +++ b/docs/api-routes/api-middlewares.md @@ -1,3 +1,7 @@ +--- +description: API Routes provide built-in middlewares that parse the incoming request. Learn more about them here. +--- + # API Middlewares API routes provide built in middlewares which parse the incoming request (`req`). Those middlewares are: diff --git a/docs/api-routes/dynamic-api-routes.md b/docs/api-routes/dynamic-api-routes.md index 0624cc9ce3efa37dccf904893b46fd1644bc29cf..88aa57a7f69e9675b49a046b5210ababf839b936 100644 --- a/docs/api-routes/dynamic-api-routes.md +++ b/docs/api-routes/dynamic-api-routes.md @@ -1,6 +1,10 @@ +--- +description: You can add the dynamic routes used for pages to API Routes too. Learn how it works here. +--- + # Dynamic API Routes -API pages support [dynamic routes](/docs/routing/dynamic-routes.md), and follow the same file naming rules used for `pages`. +API routes support [dynamic routes](/docs/routing/dynamic-routes.md), and follow the same file naming rules used for `pages`. For example, the API route `pages/api/post/[pid].js` has the following code: diff --git a/docs/api-routes/introduction.md b/docs/api-routes/introduction.md index 6fce57779ace6841e81df30310f2b2f57e1480e4..d883787531346adb0402ed00ca8e5c222f99a556 100644 --- a/docs/api-routes/introduction.md +++ b/docs/api-routes/introduction.md @@ -1,3 +1,7 @@ +--- +description: Next.js supports API Routes, which allow you to build your API without leaving your Next.js app. Learn how it works here. +--- + # API Routes
diff --git a/docs/api-routes/response-helpers.md b/docs/api-routes/response-helpers.md index 64686d3b6bbe21e9c28c49f08bad7b38f663d9c2..9039bd0a60e696745e85953d376a291ac43b6111 100644 --- a/docs/api-routes/response-helpers.md +++ b/docs/api-routes/response-helpers.md @@ -1,3 +1,7 @@ +--- +description: API Routes include a set of Express.js-like methods for the response to help you creating new API endpoints. Learn how it works here. +--- + # Response Helpers The response (`res`) includes a set of Express.js-like methods to improve the developer experience and increase the speed of creating new API endpoints, take a look at the following example: diff --git a/docs/basic-features/built-in-css-support.md b/docs/basic-features/built-in-css-support.md index 643558a6ea25c0e1ae644213e56f9967113cd547..1b26fbd45b628880129e762b0aa73ca64da0039b 100644 --- a/docs/basic-features/built-in-css-support.md +++ b/docs/basic-features/built-in-css-support.md @@ -1,3 +1,7 @@ +--- +description: Next.js includes styled-jsx by default for isolated and scoped CSS support, but you can also use any other CSS-in-JS solution!. Learn more here. +--- + # Built-in CSS Support
diff --git a/docs/basic-features/data-fetching.md b/docs/basic-features/data-fetching.md index 5345fe18bbfe934f39c1e61dd66aa7628d20e153..9871ef1602a47b78eb71f0c856228a0fc2fc3efd 100644 --- a/docs/basic-features/data-fetching.md +++ b/docs/basic-features/data-fetching.md @@ -1,3 +1,7 @@ +--- +description: Next.js can handle data fetching in multiple ways for server-rendered and static pages. Learn how it works here. +--- + # Data fetching Next.js has 2 pre-rendering modes built-in: diff --git a/docs/basic-features/pages.md b/docs/basic-features/pages.md index f0a5ad8ad426e5e0949cc88885c6a2de3b717b9e..0231a9fe434b2db91a1bb53c05fa775761c7a456 100644 --- a/docs/basic-features/pages.md +++ b/docs/basic-features/pages.md @@ -1,3 +1,7 @@ +--- +description: Next.js pages are React Components exported in a file in the pages directory. Learn how they work here. +--- + # Pages A page is a [React Component](https://reactjs.org/docs/components-and-props.html) exported from a `.js`, `.ts`, or `.tsx` file in the `pages` directory. diff --git a/docs/basic-features/static-file-serving.md b/docs/basic-features/static-file-serving.md index a3696b71b3275474a03be074fc40d0df7fbd732c..5b12ea4202d215574af3f4b54e6deb3b10be5902 100644 --- a/docs/basic-features/static-file-serving.md +++ b/docs/basic-features/static-file-serving.md @@ -1,3 +1,7 @@ +--- +description: Next.js allows you to serve static files, like images, in the public directory. You can learn how it works here. +--- + # Static File Serving Next.js can serve static files, like images, under a folder called `public` in the root directory. Files inside `public` can then be referenced by your code starting from the base URL (`/`). diff --git a/docs/basic-features/typescript.md b/docs/basic-features/typescript.md index 1036351b8217324cbf8ba05cd218e1ede7b982d7..b01643cf2be3304f473c54a9803838e308a9515c 100644 --- a/docs/basic-features/typescript.md +++ b/docs/basic-features/typescript.md @@ -1,3 +1,7 @@ +--- +description: Next.js supports TypeScript by default and has built-in types for pages and the API. You can get started with Next.js and TypeScript here. +--- + # TypeScript
diff --git a/docs/deployment.md b/docs/deployment.md index 4dad075468db0769d8f15520ff61eb9ba2fadae2..c934f76986cbe4ddd4cd6543e5b7ef281a27822b 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -1,3 +1,7 @@ +--- +description: Compile and deploy your Next.js app to production with ZEIT Now and other hosting alternatives. +--- + # Deployment To go to production Next.js has a `next build` command. When ran it will compile your project and automatically apply numerous optimizations. diff --git a/docs/faq.md b/docs/faq.md index 5badcf96bb0e48590fe9a141e11b44eb093037c4..311b788828d8d9d6f7dc1edf7945323a9213dfb4 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,3 +1,7 @@ +--- +description: Get to know more about Next.js with the frequently asked questions. +--- + # Frequently Asked Questions
diff --git a/docs/getting-started.md b/docs/getting-started.md index 79f646c1344225b5dd1b466ace7d9126c40575e9..6beb43ece86e197a4219c264db0be19b6348d0e1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,5 +1,5 @@ --- -description: Getting started with Next.js. +description: Get started with Next.js in the official documentation, and learn more about all our features! --- # Getting Started diff --git a/docs/routing/dynamic-routes.md b/docs/routing/dynamic-routes.md index 7d5ab9381e8d48ec488a9e92597dc233e37b7787..7ae275d3ddb9ed47f86332f2413c2ce04765c867 100644 --- a/docs/routing/dynamic-routes.md +++ b/docs/routing/dynamic-routes.md @@ -1,3 +1,7 @@ +--- +description: Dynamic Routes are pages that allow you to add custom params to your URLs. Start creating Dynamic Routes and learn more here. +--- + # Dynamic Routes
diff --git a/docs/routing/imperatively.md b/docs/routing/imperatively.md index 112d96ee34301a87cb885c83002948814501a176..f555132a0c5bd72e40264e405b413a4bac787b4f 100644 --- a/docs/routing/imperatively.md +++ b/docs/routing/imperatively.md @@ -1,3 +1,7 @@ +--- +description: Client-side navigations are also possible using the Router API instead of the Link component. Learn more here. +--- + # Imperatively
diff --git a/docs/routing/introduction.md b/docs/routing/introduction.md index 185c3bdc6ff085c9e9084d671ced6f25b00ad106..8273358ab138d7b9b06da30ddc7e1b0e103ffa43 100644 --- a/docs/routing/introduction.md +++ b/docs/routing/introduction.md @@ -1,3 +1,7 @@ +--- +description: Next.js has a built-in, opinionated, and file-system based Router. You can learn how it works here. +--- + # Routing Next.js has a file-system based router built on the [concept of pages](/docs/basic-features/pages.md). diff --git a/docs/routing/shallow-routing.md b/docs/routing/shallow-routing.md index 390194890df1ba088c8c4118309b6ac65dad0dce..96fdb6dc4405a1b94e80a7df16bc84c987184ac5 100644 --- a/docs/routing/shallow-routing.md +++ b/docs/routing/shallow-routing.md @@ -1,3 +1,7 @@ +--- +description: You can use shallow routing to change the URL without triggering a new page change. Learn more here. +--- + # Shallow Routing