docs(api): update navigation in readme

hybridables · Oct 25, 2016 · df1bba6 · df1bba6
1 parent 2d8b16c
commit df1bba6
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 22 deletions.
diff --git a/.verb.md b/.verb.md
@@ -56,6 +56,8 @@ alwaysDone(async function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Callbacks completion
 
 ```js
@@ -71,6 +73,8 @@ alwaysDone(function (cb) {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Synchronous functions
 
 #### Returning a value
@@ -93,6 +97,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Promises
 
 #### Returning a resolved Promise
@@ -115,6 +121,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Streams
 
 #### Unpiped streams
@@ -150,6 +158,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Observables
 
 #### Empty observable
@@ -183,6 +193,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Child Process
 
 #### Successful exec
@@ -221,6 +233,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Handling native errors
 
 ```js
@@ -233,6 +247,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Always completes
 > It may looks strange, but it's logical.
 

diff --git a/README.md b/README.md
@@ -21,23 +21,10 @@
   * [async/await completion](#asyncawait-completion)
   * [Callbacks completion](#callbacks-completion)
   * [Synchronous functions](#synchronous-functions)
-    + [Returning a value](#returning-a-value)
-    + [Returning an error](#returning-an-error)
   * [Promises](#promises)
-    + [Returning a resolved Promise](#returning-a-resolved-promise)
-    + [Returning a rejected Promise](#returning-a-rejected-promise)
   * [Streams](#streams)
-    + [Unpiped streams](#unpiped-streams)
-    + [Failing unpiped streams](#failing-unpiped-streams)
-    + [Failing piped streams](#failing-piped-streams)
   * [Observables](#observables)
-    + [Empty observable](#empty-observable)
-    + [Successful observable](#successful-observable)
-    + [Failing observable](#failing-observable)
   * [Child Process](#child-process)
-    + [Successful exec](#successful-exec)
-    + [Failing exec](#failing-exec)
-    + [Failing spawn](#failing-spawn)
   * [Handling native errors](#handling-native-errors)
   * [Always completes](#always-completes)
 - [Contributing](#contributing)
@@ -111,6 +98,8 @@ alwaysDone(async function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Callbacks completion
 
 ```js
@@ -126,6 +115,8 @@ alwaysDone(function (cb) {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Synchronous functions
 
 #### Returning a value
@@ -148,6 +139,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Promises
 
 #### Returning a resolved Promise
@@ -170,6 +163,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Streams
 
 #### Unpiped streams
@@ -205,6 +200,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Observables
 
 #### Empty observable
@@ -238,6 +235,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Child Process
 
 #### Successful exec
@@ -276,6 +275,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Handling native errors
 
 ```js
@@ -288,6 +289,8 @@ alwaysDone(function () {
 })
 ```
 
+**[back to top](#table-of-contents)**
+
 ### Always completes
 > It may looks strange, but it's logical.
 
@@ -308,6 +311,14 @@ But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 [![tunnckoCore.tk][author-www-img]][author-www-url] [![keybase tunnckoCore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]
 
+[async-done]: https://github.com/gulpjs/async-done
+[dezalgo]: https://github.com/npm/dezalgo
+[end-of-stream]: https://github.com/mafintosh/end-of-stream
+[on-stream-end]: https://github.com/tunnckocore/on-stream-end
+[once]: https://github.com/isaacs/once
+[try-catch-callback]: https://github.com/tunnckocore/try-catch-callback
+[try-catch-core]: https://github.com/tunnckocore/try-catch-core
+
 [npmjs-url]: https://www.npmjs.com/package/always-done
 [npmjs-img]: https://img.shields.io/npm/v/always-done.svg?label=always-done
 
@@ -353,10 +364,3 @@ But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md)
 [new-message-url]: https://github.com/tunnckoCore/ama
 [new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg
 
-[async-done]: https://github.com/gulpjs/async-done
-[dezalgo]: https://github.com/npm/dezalgo
-[end-of-stream]: https://github.com/mafintosh/end-of-stream
-[on-stream-end]: https://github.com/tunnckocore/on-stream-end
-[once]: https://github.com/isaacs/once
-[try-catch-callback]: https://github.com/tunnckocore/try-catch-callback
-[try-catch-core]: https://github.com/tunnckocore/try-catch-core
diff --git a/package.json b/package.json
@@ -60,7 +60,7 @@
     "toc": {
       "render": true,
       "method": "preWrite",
-      "maxdepth": 4
+      "maxdepth": 3
     },
     "layout": "empty",
     "tasks": [
@@ -82,4 +82,4 @@
       "try-catch-core"
     ]
   }
-}
+}