Skip to content

Commit eeabb52

Browse files
mayank23Timer
authored andcommitted
Update README.md (#6749)
- fix runtime configuration example to use `customKey` - standardize warning callouts to use a block quote and bold "**Warning:**" text. Previously there were different ways a warning was mentioned on the docs page: - A warning emoji. The warning emoji didn't render in the actual site. <img width="770" alt="Screen Shot 2019-03-21 at 9 22 21 AM" src="https://user-images.githubusercontent.com/1103708/54759302-c655f380-4bbb-11e9-9116-b0fdc2467bc3.png"> - Italicized "Warning" text. Imo, does not stand out on the page. <img width="663" alt="Screen Shot 2019-03-21 at 9 24 43 AM" src="https://user-images.githubusercontent.com/1103708/54759376-f604fb80-4bbb-11e9-85c6-6589b7738dee.png">
1 parent ef9c39e commit eeabb52

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

packages/next/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,7 +1536,7 @@ Some commonly asked for features are available as modules:
15361536
- [@zeit/next-preact](https://github.com/zeit/next-plugins/tree/master/packages/next-preact)
15371537
- [@zeit/next-typescript](https://github.com/zeit/next-plugins/tree/master/packages/next-typescript)
15381538

1539-
_Warning: The `webpack` function is executed twice, once for the server and once for the client. This allows you to distinguish between client and server configuration using the `isServer` property_
1539+
> **Warning:** The `webpack` function is executed twice, once for the server and once for the client. This allows you to distinguish between client and server configuration using the `isServer` property
15401540
15411541
Multiple configurations can be combined together with function composition. For example:
15421542

@@ -1703,7 +1703,7 @@ export default Index
17031703
```
17041704
> **Warning:** Note that it is not possible to destructure process.env variables due to the webpack `DefinePlugin` replacing process.env.XXXX inline at build time
17051705
1706-
```js
1706+
```js
17071707
// Will not work
17081708
const { CUSTOM_KEY, CUSTOM_SECRET } = process.env;
17091709
AuthMethod({ key: CUSTOM_KEY, secret: CUSTOM_SECRET });
@@ -1717,8 +1717,8 @@ AuthMethod({ key: process.env.CUSTOM_KEY, secret: process.env.CUSTOM_SECRET });
17171717

17181718
> **Warning:** Note that this option is not available when using `target: 'serverless'`
17191719
1720-
> :warning: Generally you want to use build-time configuration to provide your configuration.
1721-
> The reason for this is that runtime configuration adds a small rendering / initialization overhead.
1720+
> **Warning:** Generally you want to use build-time configuration to provide your configuration.
1721+
The reason for this is that runtime configuration adds a small rendering / initialization overhead.
17221722

17231723
The `next/config` module gives your app access to the `publicRuntimeConfig` and `serverRuntimeConfig` stored in your `next.config.js`.
17241724

0 commit comments

Comments
 (0)