|
7 | 7 |
|
8 | 8 | next-on-netlify is a utility for hosting NextJS applications with Server-Side Rendering on Netlify. It wraps your NextJS application in a tiny compatibility layer, so that pages can be server-side rendered with Netlify functions.
|
9 | 9 |
|
10 |
| - |
11 |
| - |
12 | 10 | - Demo: https://next-on.netlify.com/
|
13 | 11 | - Example repository: https://github.com/FinnWoelm/next-on-netlify-demo
|
14 | 12 |
|
| 13 | +## Table of Contents |
| 14 | +* [Installation](#installation) |
| 15 | +* [Setup](#setup) |
| 16 | + - [1. Set NextJS target to serverless](#1-set-nextjs--target-to-serverless) |
| 17 | + - [2. Add postbuild hook](#2-add-postbuild-hook) |
| 18 | + - [3. Configure Netlify](#3-configure-netlify) |
| 19 | +* [Optional Extras](#optional-extras) |
| 20 | + - [Preview Locally](#preview-locally) |
| 21 | + - [Custom Netlify Redirects](#custom-netlify-redirects) |
| 22 | + - [Custom Netlify Functions](#custom-netlify-functions) |
| 23 | +* [Caveats](#caveats) |
| 24 | + + [Preview Mode](#preview-mode) |
| 25 | + + [Fallbacks for Pages with `getStaticPaths`](#fallbacks-for-pages-with--getstaticpaths-) |
| 26 | +* [Showcase](#showcase) |
| 27 | +* [Credits](#credits) |
| 28 | + |
15 | 29 | ## Installation
|
16 | 30 |
|
17 | 31 | ```
|
@@ -147,6 +161,15 @@ With `next-on-netlify`, when navigating to a path that is not defined in `getSta
|
147 | 161 |
|
148 | 162 | For more on this, see: [Issue #7](https://github.com/FinnWoelm/next-on-netlify/issues/7#issuecomment-636883539)
|
149 | 163 |
|
| 164 | +## Showcase |
| 165 | + |
| 166 | +The following sites are built with `next-on-netlify`: |
| 167 | + |
| 168 | + |
| 169 | +[missionbit.org](https://www.missionbit.org/) ([#18](https://github.com/FinnWoelm/next-on-netlify/pull/18#issuecomment-643828966)) |
| 170 | + |
| 171 | +Are building something awesome with `next-on-netlify`? 🔥 Let me know and we will feature it here :) |
| 172 | + |
150 | 173 | ## Credits
|
151 | 174 |
|
152 | 175 | 📣 Shoutout to [@mottox2](https://github.com/mottox2) (a pioneer of hosting NextJS on Netlify) and [@danielcondemarin](https://github.com/danielcondemarin) (author of serverless-next.js for AWS). The two were big inspirations for this package.
|
|
0 commit comments