mirror of
https://github.com/terribleplan/next.js.git
synced 2024-01-19 02:48:18 +00:00
Add table of contents to README (#735)
* Fix example README formatting * Add table of contents to README
This commit is contained in:
parent
b00f0c2044
commit
d6439d172b
37
README.md
37
README.md
|
@ -6,10 +6,45 @@
|
|||
|
||||
Next.js is a minimalistic framework for server-rendered React applications.
|
||||
|
||||
**NOTE! the README on the `master` branch might not match that of the [latest stable release](https://github.com/zeit/next.js/releases/latest)! **
|
||||
_**NOTE! the README on the `master` branch might not match that of the [latest stable release](https://github.com/zeit/next.js/releases/latest)!**_
|
||||
|
||||
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
||||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||||
<!-- https://github.com/thlorenz/doctoc -->
|
||||
|
||||
- [How to use](#how-to-use)
|
||||
- [Setup](#setup)
|
||||
- [Automatic code splitting](#automatic-code-splitting)
|
||||
- [CSS](#css)
|
||||
- [Built-in CSS support](#built-in-css-support)
|
||||
- [CSS-in-JS](#css-in-js)
|
||||
- [Static file serving (e.g.: images)](#static-file-serving-eg-images)
|
||||
- [Populating `<head>`](#populating-head)
|
||||
- [Fetching data and component lifecycle](#fetching-data-and-component-lifecycle)
|
||||
- [Routing](#routing)
|
||||
- [With `<Link>`](#with-link)
|
||||
- [Imperatively](#imperatively)
|
||||
- [Router Events](#router-events)
|
||||
- [Prefetching Pages](#prefetching-pages)
|
||||
- [With `<Link>`](#with-link-1)
|
||||
- [Imperatively](#imperatively-1)
|
||||
- [Custom server and routing](#custom-server-and-routing)
|
||||
- [Custom `<Document>`](#custom-document)
|
||||
- [Custom error handling](#custom-error-handling)
|
||||
- [Custom configuration](#custom-configuration)
|
||||
- [Customizing webpack config](#customizing-webpack-config)
|
||||
- [Customizing babel config](#customizing-babel-config)
|
||||
- [Production deployment](#production-deployment)
|
||||
- [FAQ](#faq)
|
||||
- [Roadmap](#roadmap)
|
||||
- [Authors](#authors)
|
||||
|
||||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||||
|
||||
## How to use
|
||||
|
||||
### Setup
|
||||
|
||||
Install it:
|
||||
|
||||
```bash
|
||||
|
|
Loading…
Reference in a new issue