rsnext/packages/next/README.md

[![Next.js](https://assets.vercel.com/image/upload/v1538361091/repositories/next-js/next-js.png)](https://nextjs.org)

<p align="center">
  <a aria-label="Vercel logo" href="https://vercel.com">
    <img src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000">
  </a>
  <a aria-label="NPM version" href="https://www.npmjs.com/package/next">
    <img alt="" src="https://img.shields.io/npm/v/next.svg?style=for-the-badge&labelColor=000000">
  </a>
  <a aria-label="License" href="https://github.com/vercel/next.js/blob/canary/license.md">
    <img alt="" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000">
  </a>
  <a aria-label="Join the community on GitHub" href="https://github.com/vercel/next.js/discussions">
    <img alt="" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Next.js&labelColor=000000&logoWidth=20">
  </a>
</p>

## Getting Started

Visit <a aria-label="next.js learn" href="https://nextjs.org/learn">https://nextjs.org/learn</a> to get started with Next.js.

## Documentation

Visit [https://nextjs.org/docs](https://nextjs.org/docs) to view the full documentation.

## Who is using Next.js?

Next.js is used by the world's leading companies. Check out the [Next.js Showcase](https://nextjs.org/showcase) to learn more.

## Contributing

Please see our [contributing.md](/contributing.md).

## Authors

- Arunoda Susiripala ([@arunoda](https://twitter.com/arunoda)) – [Vercel](https://vercel.com/about/arunoda-zeit)
- Tim Neutkens ([@timneutkens](https://twitter.com/timneutkens)) – [Vercel](https://vercel.com/about/timneutkens)
- Naoyuki Kanezawa ([@nkzawa](https://twitter.com/nkzawa)) – [Vercel](https://vercel.com/about/nkzawa)
- Tony Kovanen ([@tonykovanen](https://twitter.com/tonykovanen)) – [Vercel](https://vercel.com)
- Guillermo Rauch ([@rauchg](https://twitter.com/rauchg)) – [Vercel](https://vercel.com/about/rauchg)
- Dan Zajdband ([@impronunciable](https://twitter.com/impronunciable)) – Knight-Mozilla / Coral Project
-												More renaming ZEIT → Vercel (#12649)


											
										
										
											2020-05-09 17:21:53 +02:00
+								[![Next.js](https://assets.vercel.com/image/upload/v1538361091/repositories/next-js/next-js.png)](https://nextjs.org)
-												initial spec

											
										
										
											2016-10-06 01:35:00 +02:00
-												[Enhancement]: Update README buttons (#8235)

* Update CN README for consistency

* Add buttons to README.md

* Center nextjs learn text

* Update CN README for consistency

* fix README link in README-zh-CN.md

											
										
										
											2019-08-04 15:33:15 +02:00
+								<p align="center">
-												Link Made by Vercel to vercel.com (#12702)


											
										
										
											2020-05-11 08:14:54 +02:00
+								  <a aria-label="Vercel logo" href="https://vercel.com">
-												Improve Vercel's badge (#15946)


											
										
										
											2020-08-06 18:35:36 +02:00
+								    <img src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000">
-												[Enhancement]: Update README buttons (#8235)

* Update CN README for consistency

* Add buttons to README.md

* Center nextjs learn text

* Update CN README for consistency

* fix README link in README-zh-CN.md

											
										
										
											2019-08-04 15:33:15 +02:00
+								  </a>
 								  <a aria-label="NPM version" href="https://www.npmjs.com/package/next">
 								    <img alt="" src="https://img.shields.io/npm/v/next.svg?style=for-the-badge&labelColor=000000">
 								  </a>
-												Update references to zeit/next.js (#13463)


											
										
										
											2020-05-27 23:51:11 +02:00
+								  <a aria-label="License" href="https://github.com/vercel/next.js/blob/canary/license.md">
-												doc: typo fix (#8460)

* doc: typo fix

* fix glitch

											
										
										
											2019-08-21 14:38:14 +02:00
+								    <img alt="" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000">
-												[Enhancement]: Update README buttons (#8235)

* Update CN README for consistency

* Add buttons to README.md

* Center nextjs learn text

* Update CN README for consistency

* fix README link in README-zh-CN.md

											
										
										
											2019-08-04 15:33:15 +02:00
+								  </a>
-												Update references to zeit/next.js (#13463)


											
										
										
											2020-05-27 23:51:11 +02:00
+								  <a aria-label="Join the community on GitHub" href="https://github.com/vercel/next.js/discussions">
-												[Enhancement]: Update README buttons (#8235)

* Update CN README for consistency

* Add buttons to README.md

* Center nextjs learn text

* Update CN README for consistency

* fix README link in README-zh-CN.md

											
										
										
											2019-08-04 15:33:15 +02:00
+								    <img alt="" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Next.js&labelColor=000000&logoWidth=20">
 								  </a>
 								</p>
-												Slack badge (#176)


											
										
										
											2016-11-02 20:02:56 +01:00
-												Update readme to link to the new docs (#10096)

* Updated next readme

* Delete README_old.md

* Update README.md

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>

											
										
										
											2020-01-15 11:25:18 +01:00
+								## Getting Started
-												Update Readme.md
											
										
										
											2016-10-24 21:59:46 +02:00
-												Update readme to link to the new docs (#10096)

* Updated next readme

* Delete README_old.md

* Update README.md

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>

											
										
										
											2020-01-15 11:25:18 +01:00
+								Visit <a aria-label="next.js learn" href="https://nextjs.org/learn">https://nextjs.org/learn</a> to get started with Next.js.
-												Update Readme.md
											
										
										
											2016-10-24 21:59:46 +02:00
-												Update readme to link to the new docs (#10096)

* Updated next readme

* Delete README_old.md

* Update README.md

Co-authored-by: Tim Neutkens <tim@timneutkens.nl>

											
										
										
											2020-01-15 11:25:18 +01:00
+								## Documentation
-												Update Readme.md
											
										
										
											2016-10-24 21:59:46 +02:00
-												More helpful README (#14830)

* More helpful README

Updated to include more details about Next.js, link to the interactive tutorial, showcase, etc. Content mostly based on the official Next.js site.

* create-next-app readme

An updated readme with more details on options, benefits, etc.

* Apply edits from code review

Co-authored-by: Luis Alvarez D. <luis@vercel.com>

* Remove redundant intro

* Update packages/create-next-app/README.md

* Remove introduction and list in showcase

* Apply suggestions from code review

* Update packages/next/README.md

Co-authored-by: Luis Alvarez D. <luis@vercel.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
											
										
										
											2020-07-24 03:56:32 +02:00
+								Visit [https://nextjs.org/docs](https://nextjs.org/docs) to view the full documentation.
 								## Who is using Next.js?
 								Next.js is used by the world's leading companies. Check out the [Next.js Showcase](https://nextjs.org/showcase) to learn more.
-												Update Readme.md
											
										
										
											2016-10-24 21:59:46 +02:00
-												Add contributing.md (#1009)

* Add contributing.md

* Only reload example app on server changes

											
										
										
											2017-02-06 14:19:34 +01:00
+								## Contributing
-												Improve docs (#7564)

* Update getInitialprops docs

* Update docs for prefetch

* Updated prefetch docs

* Removed hotSelfAccept from docs and othr changes

* Prefer /public

* dots dots dots dots

* Added docs for Automatic Pre-rendering

* Added a note to <Link />

* Removed 404 example

* Added references for Automatic pre-rendering

* Added a typescript section for AMP

* Executed doctoc again to add AMP sections

* Properly explain automatic pre-rendering

* Switch back to LF

* Apply corrections

Co-Authored-By: Joe Haddad <timer150@gmail.com>

* Minor corrections

* Added back some periods

* Added back some periods

											
										
										
											2019-06-14 20:48:57 +02:00
+								Please see our [contributing.md](/contributing.md).
-												Add contributing.md (#1009)

* Add contributing.md

* Only reload example app on server changes

											
										
										
											2017-02-06 14:19:34 +01:00
-												Update Readme.md
											
										
										
											2016-10-24 21:40:29 +02:00
+								## Authors
-												Change authors member and links (#14367)


											
										
										
											2020-07-05 11:36:50 +02:00
+								- Arunoda Susiripala ([@arunoda](https://twitter.com/arunoda)) – [Vercel](https://vercel.com/about/arunoda-zeit)
 								- Tim Neutkens ([@timneutkens](https://twitter.com/timneutkens)) – [Vercel](https://vercel.com/about/timneutkens)
 								- Naoyuki Kanezawa ([@nkzawa](https://twitter.com/nkzawa)) – [Vercel](https://vercel.com/about/nkzawa)
-												Rename ZEIT to Vercel (#12075)

* Find/replace

* Update more URLs

* More rename

* Fix remaining examples

* More updates

* Update create-next-app

* Update remaining text

* Update

Co-authored-by: Shu Uesugi <shu@chibicode.com>
											
										
										
											2020-04-21 11:47:12 +02:00
+								- Tony Kovanen ([@tonykovanen](https://twitter.com/tonykovanen)) – [Vercel](https://vercel.com)
-												Change authors member and links (#14367)


											
										
										
											2020-07-05 11:36:50 +02:00
+								- Guillermo Rauch ([@rauchg](https://twitter.com/rauchg)) – [Vercel](https://vercel.com/about/rauchg)
-												Fix JSX in readme (#2512)

An unclosed tag was resulting in some broken syntax highlighting.
											
										
										
											2017-07-09 06:54:47 +02:00
+								- Dan Zajdband ([@impronunciable](https://twitter.com/impronunciable)) – Knight-Mozilla / Coral Project