summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPeter Dave Hello2017-10-13 15:59:57 +0800
committerPeter Dave Hello2017-10-13 15:59:57 +0800
commit6fadd9126ea6937d5a0fbf685c536c37fc8afaa9 (patch)
tree369887185746d307f8b4449452e1baed6de9547c /README.md
parent4ebda60165d7fc272302ed86386ed4fe0badb7a7 (diff)
Add "Table of Contents" in README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6012b35a..27aaf625 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