Merge pull request #2114 from dokku/table-of-contents

Add table of contents to sidebar when there is a table of contents

docs/application-deployment.md

@@ -182,11 +182,11 @@ This is in particular useful, then you want to deploy to root domain, as
 
 ## Dokku/Docker Container Management Compatibility
 
-Dokku is, at its core, a docker container manager. Thus, it does not necessarily play well with other out-of-band processes interacting with the docker daemon. One thing to note as in [issue #1220](https://github.com/dokku/dokku/issues/1220), dokku executes a cleanup function prior to every deployment. 
+Dokku is, at its core, a docker container manager. Thus, it does not necessarily play well with other out-of-band processes interacting with the docker daemon. One thing to note as in [issue #1220](https://github.com/dokku/dokku/issues/1220), dokku executes a cleanup function prior to every deployment.
 
 As of 0.5.x, this function removes all containers with the label `dokku` where the status is either `dead` or `exited`, as well as all `dangling` images. Previous versions would remove `dead` or `exited` containers, regardless of their label.
 
-### Adding deploy users
+## Adding deploy users
 
 See the [user management documentation](/dokku/deployment/user-management).
 
@@ -198,7 +198,7 @@ See the [nginx documentation](/dokku/nginx/#default-site).
 
 See the [dockerfile documentation](/dokku/deployment/dockerfiles/).
 
-### Specifying a custom buildpack
+## Specifying a custom buildpack
 
 See the [buildpack documentation](/dokku/deployment/buildpacks/).
 

docs/deployment/buildpacks.md

@@ -65,7 +65,7 @@ Building containers with buildpacks currently results in a persistent `cache` di
 sudo rm -rf /home/dokku/APP/cache/*
 ```
 
-### Curl Build Timeouts
+## Curl Build Timeouts
 
 Certain buildpacks may time out in retrieving dependencies via curl. This can happen when your network connection is poor or if there is significant network congestion. You may see a message similar to `gzip: stdin: unexpected end of file` after a curl command.
 

docs/deployment/images.md

@@ -56,7 +56,7 @@ root@dokku:~# dokku tags:deploy node-js-app v0.9.0
 
 ```
 
-## Deploying image from CI
+## Deploying an image from CI
 
 To ensure your builds are always reproducible, it's considered bad practice to store build
 artifacts in your repository. For some projects however, building artifacts during deployment

docs/dns.md

@@ -2,27 +2,30 @@
 
 > Note: This is a work in progress.
 
-### DNS Versions
+## DNS Versions
 
 There are many different DNS servers 'in the wild'.  Some of the popular ones on Linux are BIND, dnsmasq, and pdns.  Windows has its own built-in DNS server as well as Unbound, Posadis, and more.  A full list of DNS packages can be found on Wikipedia under [Comparison of DNS Server Software](http://en.wikipedia.org/wiki/Comparison_of_DNS_server_software).  In addition to the various DNS packages, there are tens of thousands of [Managed DNS Providers](http://en.wikipedia.org/wiki/List_of_managed_DNS_providers) out that all have different DNS interfaces.
 
-### Focus
+## Focus
 
 Because there are so many different DNS server packages out there as well as a tremendous number of Managed DNS Providers, we will focus on the concepts of DNS as well as providing examples in the 'BIND' format so you can adapt the information to your own server package or managed DNS provider.
 
-### Assumptions
+## Assumptions
 
 * We assume you have a passing familiarity with DNS.  If not, you can read an [in-depth article](http://www.diaryofaninja.com/blog/2012/03/03/devops-dns-for-developers-ndash-now-therersquos-no-excuse-not-to-know) on DNS.  But basically you need to know that DNS changes names (like example.tld) into addresses (like 127.0.0.1)
 * We assume you already have a domain name registered and pointed to your favorite Managed DNS Provider or have your own BIND DNS server running.
 * You have a server on the internet and are about to follow the instructions in the [README](https://github.com/dokku/dokku/blob/master/README.md) to get dokku installed.  Don't do the install just yet though.
 
+## Caching
 
-### HELP!
+Please remember that DNS relies heavily on _caching_.  Changes you make to DNS could take anywhere from a few seconds to a few *days* to propagate.  If you tried surfing to example.tld, then changed the IP address in DNS, it could be a while before your computer picks up on the changes.
+
+## HELP!
 
 Don't be afraid to ask if you need help.  Create a [new issue](https://github.com/dokku/dokku/issues) and someone will be glad to assist you.
 
 
-# Getting started
+## Getting started
 
 For the examples, we will use the domain name `example.tld` and the IP address `127.0.0.1`.
 
@@ -30,17 +33,11 @@ Dokku uses DNS to differentiate between apps on your dokku-powered server.  If y
 
 To get started, you need to know the IP address of your dokku server.  Connect to it and run `ifconfig` or `ip addr` to see the IP address.
 
-# Caching
-
-Please remember that DNS relies heavily on _caching_.  Changes you make to DNS could take anywhere from a few seconds to a few *days* to propagate.  If you tried surfing to example.tld, then changed the IP address in DNS, it could be a while before your computer picks up on the changes.
-
-## The two methods
-
 Now you have to make a decision about your domain.  Do you want everything and anything at `example.tld` to go to your dokku server, or would you rather use a 'sub domain' for your dokku server?
 
 In other words, do you want your applications on your dokku server accessible via `myapp.example.tld` or via `myapp.myserver.example.tld`?
 
-### Using a sub-domain (myapp.myserver.example.tld)
+#### Using a sub-domain (myapp.myserver.example.tld)
 
 Using a sub-domain is easy.  When you set up your server, you probably gave it a name like `myserver.example.tld`.
 
@@ -75,7 +72,7 @@ If they all return your IP address, you have set DNS up properly for dokku.  You
 
 Proceed with the setup instructions in the [README](https://github.com/dokku/dokku/blob/master/README.md)
 
-### Using the root of your domain (myapp.example.tld)
+#### Using the root of your domain (myapp.example.tld)
 
 This section is a work in progress.  It is incomplete.
 

docs/template.html

@@ -47,6 +47,15 @@
     <!-- <link href="/dokku/docs/assets/style.css" rel="stylesheet"> -->
     <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css" rel="stylesheet">
     <style>
+    .table-of-contents {
+        font-size: 0.8em;
+        padding: 1em;
+        margin: 0 0 0.5em 0.5em;
+    }
+    .table-of-contents ul {
+      margin-bottom: 0;
+      padding-left: 20px;
+    }
     </style>
   </head>
   <body>
@@ -188,6 +197,8 @@
           currentVersionEl = document.querySelectorAll('.rst-current-version')[0],
           currentVersion = currentVersionEl.getAttribute('data-ref'),
           versionContainer = document.querySelectorAll('.rst-versions.rst-badge')[0],
+          pageHeader = document.querySelectorAll('.markdown-body p')[0],
+          headers = document.querySelectorAll('h2, h3, h4'),
           classNames = ['table', 'table-striped', 'table-hover', 'table-condensed'],
           localPath = location.pathname.split('/').splice(2).join("/"),
           addClass = function (el, className) {
@@ -238,6 +249,46 @@
         }
       };
 
+      var ToC =
+        "<nav role='navigation' class='table-of-contents'>" +
+          "<ul>";
+
+      var newLine, el, title, link, currentDepth, count = 0, lastNodeDepth = null;
+      Array.prototype.forEach.call(headers, function (el, i) {
+        count++;
+        title = el.innerText || element.textContent;
+        link = "#" + el.getAttribute('id');
+        currentDepth = parseInt(el.nodeName.replace('H', ''), 10);
+
+        newLine =
+          "<li>" +
+            "<a href='" + link + "' class='current-depth-" + currentDepth + "'>" +
+              title +
+            "</a>" +
+          "</li>";
+
+        if (currentDepth === lastNodeDepth || lastNodeDepth === null) {
+        } else if (currentDepth > lastNodeDepth) {
+          newLine = '<ul>' + newLine;
+        } else if (currentDepth < lastNodeDepth) {
+          newLine = '</ul>' + newLine;
+        }
+        ToC += newLine;
+
+        lastNodeDepth = currentDepth;
+      });
+      ToC += "</ul></nav>";
+
+      if (count > 1) {
+        var navItems = document.querySelectorAll('.list-group-item');
+        Array.prototype.forEach.call(navItems, function(el, i){
+          if (el.getAttribute('href') == location.pathname) {
+            el.insertAdjacentHTML('afterEnd', ToC);
+          }
+        });
+      }
+
+
       Array.prototype.forEach.call(blockquotes, function (el, i) {
         if (el.innerHTML.toLowerCase().indexOf('new as of') !== -1) {
           addClass(el, 'new-as-of');

docs/troubleshooting.md

@@ -1,4 +1,4 @@
-## Troubleshooting
+# Troubleshooting
 
 __Symptom:__ I deployed my app but I am getting the default nginx page