From 7fc850e28a3ed41ee05705136e20b9c09704c095 Mon Sep 17 00:00:00 2001 From: Luis Alvarez D Date: Mon, 20 Jan 2020 15:40:20 -0500 Subject: [PATCH] [docs] Added related links to next.config.js (#10174) * Added related links * Added missing dots --- docs/advanced-features/custom-app.md | 2 +- .../api-reference/next.config.js/build-target.md | 16 ++++++++++++++++ .../cdn-support-with-asset-prefix.md | 16 ++++++++++++++++ docs/api-reference/next.config.js/compression.md | 9 +++++++++ .../configuring-onDemandEntries.md | 9 +++++++++ .../next.config.js/configuring-the-build-id.md | 9 +++++++++ .../next.config.js/custom-page-extensions.md | 9 +++++++++ .../next.config.js/custom-webpack-config.md | 9 +++++++++ .../next.config.js/disabling-etag-generation.md | 9 +++++++++ .../next.config.js/disabling-x-powered-by.md | 9 +++++++++ .../next.config.js/environment-variables.md | 9 +++++++++ .../next.config.js/exportPathMap.md | 16 ++++++++++++++++ .../next.config.js/ignoring-typescript-errors.md | 16 ++++++++++++++++ .../next.config.js/runtime-configuration.md | 16 ++++++++++++++++ .../setting-a-custom-build-directory.md | 9 +++++++++ .../static-optimization-indicator.md | 16 ++++++++++++++++ docs/api-routes/introduction.md | 2 +- docs/basic-features/pages.md | 4 ++-- docs/basic-features/typescript.md | 2 +- docs/getting-started.md | 4 ++-- 20 files changed, 184 insertions(+), 7 deletions(-) diff --git a/docs/advanced-features/custom-app.md b/docs/advanced-features/custom-app.md index b2883969a1..df41c6f12a 100644 --- a/docs/advanced-features/custom-app.md +++ b/docs/advanced-features/custom-app.md @@ -48,7 +48,7 @@ For more information on what to do next, we recommend the following sections:
Automatic Static Optimization: - Learn more about how Next.js automatically optimizes your pages. + Next.js automatically optimizes your app to be static HTML whenever possible. Learn how it works here.
diff --git a/docs/api-reference/next.config.js/build-target.md b/docs/api-reference/next.config.js/build-target.md index 06651ebf01..7cdec149db 100644 --- a/docs/api-reference/next.config.js/build-target.md +++ b/docs/api-reference/next.config.js/build-target.md @@ -27,3 +27,19 @@ module.exports = { target: 'serverless', } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
+ +
+ + Deployment: + Compile and deploy your Next.js app to production. + +
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 c08b9ab219..7b6435c1eb 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 @@ -18,3 +18,19 @@ module.exports = { ``` Next.js will automatically use your prefix in the scripts it loads, but this has no effect whatsoever on the [public](/docs/basic-features/static-file-serving.md) folder; if you want to serve those assets over a CDN, you'll have to introduce the prefix yourself. One way of introducing a prefix that works inside your components and varies by environment is documented [in this example](https://github.com/zeit/next.js/tree/canary/examples/with-universal-configuration-build-time). + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
+ +
+ + Static File Serving: + Serve static files, like images, in the public directory. + +
diff --git a/docs/api-reference/next.config.js/compression.md b/docs/api-reference/next.config.js/compression.md index 9f98132b1a..c20ebe798e 100644 --- a/docs/api-reference/next.config.js/compression.md +++ b/docs/api-reference/next.config.js/compression.md @@ -13,3 +13,12 @@ module.exports = { compress: false, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
diff --git a/docs/api-reference/next.config.js/configuring-onDemandEntries.md b/docs/api-reference/next.config.js/configuring-onDemandEntries.md index 8b05d1c580..2e9133a9d2 100644 --- a/docs/api-reference/next.config.js/configuring-onDemandEntries.md +++ b/docs/api-reference/next.config.js/configuring-onDemandEntries.md @@ -18,3 +18,12 @@ module.exports = { }, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
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 ede037ff20..1d22438a7c 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 @@ -16,3 +16,12 @@ module.exports = { }, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
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 bdec8334e9..54fc78f6f9 100644 --- a/docs/api-reference/next.config.js/custom-page-extensions.md +++ b/docs/api-reference/next.config.js/custom-page-extensions.md @@ -13,3 +13,12 @@ module.exports = { pageExtensions: ['mdx', 'jsx', 'js', 'ts', 'tsx'], } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
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 df75f9998e..5e0f74a565 100644 --- a/docs/api-reference/next.config.js/custom-webpack-config.md +++ b/docs/api-reference/next.config.js/custom-webpack-config.md @@ -65,3 +65,12 @@ module.exports = { }, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
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 27ecf6660d..71a2f82cf5 100644 --- a/docs/api-reference/next.config.js/disabling-etag-generation.md +++ b/docs/api-reference/next.config.js/disabling-etag-generation.md @@ -13,3 +13,12 @@ module.exports = { generateEtags: false, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
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 a6d3db934f..1595d8e300 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 @@ -11,3 +11,12 @@ module.exports = { poweredByHeader: false, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
diff --git a/docs/api-reference/next.config.js/environment-variables.md b/docs/api-reference/next.config.js/environment-variables.md index 4bd74196f8..068d366f49 100644 --- a/docs/api-reference/next.config.js/environment-variables.md +++ b/docs/api-reference/next.config.js/environment-variables.md @@ -45,3 +45,12 @@ Will end up being: ```jsx return

The value of customKey is: {'my-value'}

``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
diff --git a/docs/api-reference/next.config.js/exportPathMap.md b/docs/api-reference/next.config.js/exportPathMap.md index bf367d6b31..449f00e038 100644 --- a/docs/api-reference/next.config.js/exportPathMap.md +++ b/docs/api-reference/next.config.js/exportPathMap.md @@ -66,3 +66,19 @@ module.exports = { exportTrailingSlash: true, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
+ +
+ + Static HTML Export: + Export your Next.js app to static HTML. + +
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 bde16ed256..306b77a3b8 100644 --- a/docs/api-reference/next.config.js/ignoring-typescript-errors.md +++ b/docs/api-reference/next.config.js/ignoring-typescript-errors.md @@ -40,3 +40,19 @@ module.exports = { }, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
+ +
+ + TypeScript: + Get started with TypeScript in Next.js. + +
diff --git a/docs/api-reference/next.config.js/runtime-configuration.md b/docs/api-reference/next.config.js/runtime-configuration.md index b176acbb5e..cdda97cdbd 100644 --- a/docs/api-reference/next.config.js/runtime-configuration.md +++ b/docs/api-reference/next.config.js/runtime-configuration.md @@ -52,3 +52,19 @@ function MyImage() { export default MyImage ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
+ +
+ + Environment Variables: + Access environment variables in your Next.js application at build time. + +
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 df5113ab88..47e269bfa9 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 @@ -17,3 +17,12 @@ module.exports = { Now if you run `next build` Next.js will use `build` instead of the default `.next` folder. > `distDir` **should not** leave your project directory. For example, `../build` is an **invalid** directory. + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
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 92ec75b668..7ef296f9c3 100644 --- a/docs/api-reference/next.config.js/static-optimization-indicator.md +++ b/docs/api-reference/next.config.js/static-optimization-indicator.md @@ -17,3 +17,19 @@ module.exports = { }, } ``` + +## Related + +
+ + Introduction to next.config.js: + Learn more about the configuration file used by Next.js. + +
+ +
+ + Automatic Static Optimization: + Next.js automatically optimizes your app to be static HTML whenever possible. Learn how it works here. + +
diff --git a/docs/api-routes/introduction.md b/docs/api-routes/introduction.md index 491c5f62ba..9537c9464e 100644 --- a/docs/api-routes/introduction.md +++ b/docs/api-routes/introduction.md @@ -71,6 +71,6 @@ For more information on what to do next, we recommend the following sections:
TypeScript: - Add TypeScript to your API Routes + Add TypeScript to your API Routes.
diff --git a/docs/basic-features/pages.md b/docs/basic-features/pages.md index 61c0b3a757..ade94c5e8a 100644 --- a/docs/basic-features/pages.md +++ b/docs/basic-features/pages.md @@ -106,13 +106,13 @@ For more information on what to do next, we recommend the following sections:
Routing: - Learn more about routing in Next.js + Learn more about routing in Next.js.
TypeScript: - Add TypeScript to your pages + Add TypeScript to your pages.
diff --git a/docs/basic-features/typescript.md b/docs/basic-features/typescript.md index b01643cf2b..aa2366a9fc 100644 --- a/docs/basic-features/typescript.md +++ b/docs/basic-features/typescript.md @@ -1,5 +1,5 @@ --- -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. +description: Next.js supports TypeScript by default and has built-in types for pages and the API. You can get started with TypeScript in Next.js here. --- # TypeScript diff --git a/docs/getting-started.md b/docs/getting-started.md index 498cc24032..357e19d039 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -73,13 +73,13 @@ For more information on what to do next, we recommend the following sections:
Pages: - Learn more about what pages are in Next.js + Learn more about what pages are in Next.js.
CSS Support: - Use the built-in CSS support to add custom styles to your app + Use the built-in CSS support to add custom styles to your app.
-- GitLab