From d6439d172b70e866becfa380af244bba9950fb6e Mon Sep 17 00:00:00 2001 From: Loren Sands-Ramshaw Date: Thu, 9 Feb 2017 06:47:20 -0500 Subject: [PATCH] Add table of contents to README (#735) * Fix example README formatting * Add table of contents to README --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f246c4d4..35d94c37 100644 --- a/README.md +++ b/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)!**_ + + + + + +- [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 ``](#populating-head) + - [Fetching data and component lifecycle](#fetching-data-and-component-lifecycle) + - [Routing](#routing) + - [With ``](#with-link) + - [Imperatively](#imperatively) + - [Router Events](#router-events) + - [Prefetching Pages](#prefetching-pages) + - [With ``](#with-link-1) + - [Imperatively](#imperatively-1) + - [Custom server and routing](#custom-server-and-routing) + - [Custom ``](#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) + + ## How to use +### Setup + Install it: ```bash