Skip to content
This repository was archived by the owner on May 10, 2021. It is now read-only.

update README to explain the future of next on netlify #114

Merged
merged 2 commits into from
Dec 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,6 @@ jspm_packages
# Optional REPL history
.node_repl_history
.next

# Github
.github
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,25 @@
</a>
</p>


`next-on-netlify` is a utility for enabling server-side rendering in Next.js on Netlify. It wraps your application in a tiny compatibility layer, so that pages can use Netlify Functions to be server-side rendered.

**TL;DR: You can enable SSR in your Next.js applications with 3 simple steps, listed [here](#setup)!**
- Build plugin [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs)
- [Plugin npm package](https://www.npmjs.com/package/@netlify/plugin-nextjs)

## Next on Netlify Roadmap

The future of Next.js on Netlify is growing beyond `next-on-netlify`. The recommended path forward is to install [@netlify/plugin-nextjs](https://github.com/netlify/netlify-plugin-nextjs) - a build plugin released and supported by the team behind `next-on-netlify`.

The plugin relies on `next-on-netlify` but offers a smoother experience, including:

1. one-click, zero-config installation
2. allowing custom functions and publish directories

- Demo: https://next-on.netlify.com/
- Example repository: https://github.com/netlify-labs/next-on-netlify-demo
See the [plugin's README](https://github.com/netlify/netlify-plugin-nextjs#readme) for more information. Our team's end goal is to make the Next.js on Netlify experience as seamless as possible.

Note: since `next-on-netlify` will remain the primary source of logic for Next.js on Netlify, the existing `next-on-netlify` setup will continue to work for users who prefer manual installation and configuration.

The plugin can be found on [npm here](https://www.npmjs.com/package/@netlify/plugin-nextjs).

## Table of Contents

Expand All @@ -30,6 +42,7 @@
- [1. Set Next.js target to serverless](#1-set-nextjs-target-to-serverless)
- [2. Add postbuild hook](#2-add-postbuild-hook)
- [3. Configure Netlify](#3-configure-netlify)
- [Demo](#demo)
- [Optional Extras](#optional-extras)
- [Preview Locally](#preview-locally)
- [Custom Netlify Redirects](#custom-netlify-redirects)
Expand Down Expand Up @@ -110,6 +123,11 @@ Note: `out_functions` and `out_publish` are hard-coded into next-on-netlify. The

We're done. Let's deploy 🚀🚀🚀

## Demo

- Site: https://next-on.netlify.com/
- Code: https://github.com/netlify-labs/next-on-netlify-demo

## Optional Extras

#### Preview Locally
Expand Down