Update GitHub Pages deployment example.

examples/github-pages/README.md

@@ -0,0 +1,31 @@
+# Deploying to GitHub Pages
+
+This example supports deloying a static Next.js application (using `next export`) to GitHub Pages.
+
+## How to use
+
+Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
+
+```bash
+npx create-next-app --example github-pages nextjs-github-pages
+# or
+yarn create next-app --example github-pages nextjs-github-pages
+# or
+pnpm create next-app --example github-pages nextjs-github-pages
+```
+
+### Deploy to GitHub Pages
+
+1.  Create a new public GitHub repository.
+1.  Edit `next.config.js` to match your GitHub repository name.
+1.  Push the starter code to the `main` branch.
+1.  Run the `deploy` script (e.g. `npm run deploy`) to create the `gh-pages` branch.
+1.  On GitHub, go to **Settings** > **Pages** > **Source**, and choose `gh-pages` as the branch with the `/root` folder. Hit **Save**.
+1.  Make a change.
+1.  Run the `deploy` script again to push the changes to GitHub Pages.
+
+Congratulations! You should have a URL like:
+
+```bash
+https://<github-user-name>.github.io/<github-project-name>/
+```

examples/github-pages/next.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  basePath: '/gh-pages-test',
+}

examples/github-pages/package.json

@@ -0,0 +1,13 @@
+{
+  "private": true,
+  "scripts": {
+    "dev": "next",
+    "build": "next build && next export",
+    "deploy": "next build && touch out/.nojekyll && git add out/ && git commit -m \"Deploy\" && git subtree push --prefix out origin gh-pages"
+  },
+  "dependencies": {
+    "next": "latest",
+    "react": "latest",
+    "react-dom": "latest"
+  }
+}

examples/github-pages/pages/about.js

@@ -0,0 +1,12 @@
+import Link from 'next/link'
+
+export default function About() {
+  return (
+    <div>
+      <div>About</div>
+      <div>
+        Back to <Link href="/">Home</Link>
+      </div>
+    </div>
+  )
+}

examples/github-pages/pages/index.js

@@ -0,0 +1,9 @@
+import Link from 'next/link'
+
+export default function Home() {
+  return (
+    <div>
+      Hello World. <Link href="/about">About</Link>
+    </div>
+  )
+}