Merge branch 'canary' into examples/with-chakra-ui-typescript

vercel · Aug 30, 2020 · 5bb2d6d · 5bb2d6d
2 parents 69d508b + f17d435
commit 5bb2d6d
Show file tree

Hide file tree

Showing 468 changed files with 1,253 additions and 4,607 deletions.
diff --git a/check-examples.sh b/check-examples.sh
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+cd `dirname $0`
+
+for folder in examples/* ; do
+  cp -n packages/create-next-app/templates/default/gitignore $folder/.gitignore;
+  if [ -f "$folder/package.json" ]; then
+    cat $folder/package.json | jq '.license = "MIT"' | sponge $folder/package.json
+  fi
+done;
+
+if [[ ! -z $(git status -s) ]];then
+  echo "Detected changes"
+  git status
+  exit 1
+fi
diff --git a/check-git-ignore.sh b/check-git-ignore.sh
diff --git a/contributing.md b/contributing.md
@@ -138,8 +138,6 @@ Deploy the example using [Vercel](https://vercel.com/now):
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
@@ -148,24 +146,5 @@ npx create-next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
 yarn create next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/DIRECTORY_NAME
-cd DIRECTORY_NAME
-```
-
-Install it and run:
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
 ````
diff --git a/docs/advanced-features/measuring-performance.md b/docs/advanced-features/measuring-performance.md
@@ -158,7 +158,9 @@ export function reportWebVitals(metric) {
 >
 > ```js
 > export function reportWebVitals({ id, name, label, value }) {
->   ga('send', 'event', {
+>   // Use `window.gtag` if you initialized Google Analytics as this example:
+>   // https://github.com/vercel/next.js/blob/canary/examples/with-google-analytics/pages/_document.js
+>   window.gtag('send', 'event', {
 >     eventCategory:
 >       label === 'web-vital' ? 'Web Vitals' : 'Next.js custom metric',
 >     eventAction: name,

diff --git a/docs/api-reference/next/link.md b/docs/api-reference/next/link.md
@@ -8,6 +8,7 @@ description: Enable client-side transitions between routes with the built-in Lin
   <summary><b>Examples</b></summary>
   <ul>
     <li><a href="https://github.com/vercel/next.js/tree/canary/examples/hello-world">Hello World</a></li>
+    <li><a href="https://github.com/vercel/next.js/tree/canary/examples/active-class-name">Active className on Link</a></li>
   </ul>
 </details>
 

diff --git a/docs/basic-features/typescript.md b/docs/basic-features/typescript.md
@@ -23,7 +23,7 @@ Next.js will automatically configure this file with default values. Providing yo
 
 > Next.js uses Babel to handle TypeScript, which has some [caveats](https://babeljs.io/docs/en/babel-plugin-transform-typescript#caveats), and some [compiler options are handled differently](https://babeljs.io/docs/en/babel-plugin-transform-typescript#typescript-compiler-options).
 
-Then, run `next` (normally `npm run dev`) and Next.js will guide you through the installation of the required packages to finish the setup:
+Then, run `next` (normally `npm run dev` or `yarn dev`) and Next.js will guide you through the installation of the required packages to finish the setup:
 
 ```bash
 npm run dev

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -37,6 +37,8 @@ Install `next`, `react` and `react-dom` in your project:
 
 ```bash
 npm install next react react-dom
+# or
+yarn add next react react-dom
 ```
 
 Open `package.json` and add the following `scripts`:
@@ -71,7 +73,7 @@ function HomePage() {
 export default HomePage
 ```
 
-To start developing your application run `npm run dev`. This starts the development server on `http://localhost:3000`.
+To start developing your application run `npm run dev` or `yarn dev`. This starts the development server on `http://localhost:3000`.
 
 Visit `http://localhost:3000` to view your application.
 

diff --git a/examples/active-class-name/README.md b/examples/active-class-name/README.md
@@ -10,8 +10,6 @@ Deploy the example using [Vercel](https://vercel.com):
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
@@ -20,23 +18,4 @@ npx create-next-app --example active-class-name active-class-name-app
 yarn create next-app --example active-class-name active-class-name-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/active-class-name
-cd active-class-name
-```
-
-Install it and run:
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
diff --git a/examples/active-class-name/package.json b/examples/active-class-name/package.json
@@ -12,5 +12,5 @@
     "react": "^16.7.0",
     "react-dom": "^16.7.0"
   },
-  "license": "ISC"
+  "license": "MIT"
 }
diff --git a/examples/amp-first/README.md b/examples/amp-first/README.md
@@ -15,8 +15,6 @@ Deploy the example using [Vercel](https://vercel.com):
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
@@ -25,25 +23,6 @@ npx create-next-app --example amp-first amp-first-app
 yarn create next-app --example amp-first amp-first-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/amp-first
-cd amp-first
-```
-
-Install it and run:
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits. You will also see AMP validation errors in the console.
 
 ## Todo

diff --git a/examples/amp-first/package.json b/examples/amp-first/package.json
@@ -11,5 +11,5 @@
     "react": "^16.10.2",
     "react-dom": "^16.10.2"
   },
-  "license": "ISC"
+  "license": "MIT"
 }
diff --git a/examples/amp-story/README.md b/examples/amp-story/README.md
@@ -10,8 +10,6 @@ Deploy the example using [Vercel](https://vercel.com):
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
@@ -20,23 +18,4 @@ npx create-next-app --example amp-story amp-app
 yarn create next-app --example amp-story amp-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/amp-story
-cd amp-story
-```
-
-Install it and run:
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
diff --git a/examples/amp-story/package.json b/examples/amp-story/package.json
@@ -11,5 +11,5 @@
     "react": "^16.7.0",
     "react-dom": "^16.7.0"
   },
-  "license": "ISC"
+  "license": "MIT"
 }
diff --git a/examples/amp/README.md b/examples/amp/README.md
@@ -10,8 +10,6 @@ Deploy the example using [Vercel](https://vercel.com):
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
@@ -20,23 +18,4 @@ npx create-next-app --example amp amp-app
 yarn create next-app --example amp amp-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/amp
-cd amp
-```
-
-Install it and run:
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
diff --git a/examples/amp/package.json b/examples/amp/package.json
@@ -11,5 +11,5 @@
     "react": "^16.7.0",
     "react-dom": "^16.7.0"
   },
-  "license": "ISC"
+  "license": "MIT"
 }
diff --git a/examples/analyze-bundles/README.md b/examples/analyze-bundles/README.md
@@ -10,8 +10,6 @@ Deploy the example using [Vercel](https://vercel.com):
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
@@ -20,25 +18,6 @@ npx create-next-app --example analyze-bundles analyze-bundles-app
 yarn create next-app --example analyze-bundles analyze-bundles-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/analyze-bundles
-cd analyze-bundles
-```
-
-Install it
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 ### Analyze webpack output
 
 To analyze your webpack output, invoke the following command:

diff --git a/examples/analyze-bundles/package.json b/examples/analyze-bundles/package.json
@@ -15,5 +15,5 @@
     "react": "^16.8.0",
     "react-dom": "^16.8.0"
   },
-  "license": "ISC"
+  "license": "MIT"
 }
diff --git a/examples/api-routes-apollo-server-and-client-auth/README.md b/examples/api-routes-apollo-server-and-client-auth/README.md
@@ -6,8 +6,6 @@ In this simple example, we integrate Apollo seamlessly with [Next.js data fetchi
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
 
 ```bash
@@ -16,23 +14,4 @@ npx create-next-app --example api-routes-apollo-server-and-client-auth api-route
 yarn create next-app --example api-routes-apollo-server-and-client-auth api-routes-apollo-server-and-client-auth-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/api-routes-apollo-server-and-client-auth
-cd api-routes-apollo-server-and-client-auth
-```
-
-Install it and run:
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
diff --git a/examples/api-routes-apollo-server-and-client-auth/package.json b/examples/api-routes-apollo-server-and-client-auth/package.json
@@ -18,5 +18,5 @@
     "react-dom": "^16.7.0",
     "uuid": "8.1.0"
   },
-  "license": "ISC"
+  "license": "MIT"
 }
diff --git a/examples/api-routes-apollo-server-and-client/README.md b/examples/api-routes-apollo-server-and-client/README.md
@@ -6,8 +6,6 @@ In this simple example, we integrate Apollo seamlessly with [Next.js data fetchi
 
 ## How to use
 
-### Using `create-next-app`
-
 Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
@@ -16,23 +14,4 @@ npx create-next-app --example api-routes-apollo-server-and-client api-routes-apo
 yarn create next-app --example api-routes-apollo-server-and-client api-routes-apollo-server-and-client-app
 ```
 
-### Download manually
-
-Download the example:
-
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/api-routes-apollo-server-and-client
-cd api-routes-apollo-server-and-client
-```
-
-Install it and run:
-
-```bash
-npm install
-npm run dev
-# or
-yarn
-yarn dev
-```
-
 Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
diff --git a/examples/api-routes-apollo-server-and-client/package.json b/examples/api-routes-apollo-server-and-client/package.json
@@ -15,5 +15,5 @@
     "react": "^16.7.0",
     "react-dom": "^16.7.0"
   },
-  "license": "ISC"
+  "license": "MIT"
 }