From 6fadd9126ea6937d5a0fbf685c536c37fc8afaa9 Mon Sep 17 00:00:00 2001 From: Peter Dave Hello Date: Fri, 13 Oct 2017 15:59:57 +0800 Subject: [PATCH] Add "Table of Contents" in README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 6012b35a2..27aaf625b 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,27 @@ Still in the early stage, feel free to fork or contribute to HackMD. Thanks for using! :smile: +# Table of Contents + +- [Browsers Requirement](#browsers-requirement) +- [Installation](#installation) + - [Getting started (Native install)](#getting-started-native-install) + - [Prerequisite](#prerequisite) + - [Instructions](#instructions) + - [Heroku Deployment](#heroku-deployment) + - [HackMD by docker container](#hackmd-by-docker-container) +- [Upgrade](#upgrade) + - [Native setup](#native-setup) +- [Configuration](#configuration) + - [Environment variables (will overwrite other server configs)](#environment-variables-will-overwrite-other-server-configs) + - [Application settings `config.json`](#application-settings-configjson) + - [Third-party integration api key settings](#third-party-integration-api-key-settings) + - [Third-party integration oauth callback urls](#third-party-integration-oauth-callback-urls) +- [Developer Notes](#developer-notes) + - [Structure](#structure) + - [Operational Transformation](#operational-transformation) +- [License](#license) + # Browsers Requirement - Chrome >= 47, Chrome for Android >= 47