Implemented basics of new design

json-api · dgeb · May 19, 2015 · Mar 27, 2015 · Mar 27, 2015 · Mar 29, 2015
commit ef7f55d955cf09226b0afd48146104cda0c097db
diff --git a/_config.yml b/_config.yml
@@ -17,6 +17,8 @@ pygments: false
 port: 9876
 
 navigation:
+- title: JSON:API
+  url: /
 - title: Format
   url: /format/
 - title: Extensions
@@ -29,3 +31,9 @@ navigation:
   url: /faq/
 - title: About
   url: /about/
+
+quicklinks:
+- title: Documentation
+  url: /format/
+- title: Github
+  url: https://github.com/json-api/json-api
diff --git a/_layouts/page.html b/_layouts/page.html
@@ -9,31 +9,52 @@
     <!-- Use title if it's in the page YAML frontmatter -->
     <title>JSON API :: {{ page..title }}</title>
 
-    <link href='http://fonts.googleapis.com/css?family=Titillium+Web:400,600,700,900' rel='stylesheet' type='text/css'>
+    <link href='http://fonts.googleapis.com/css?family=Titillium+Web:400,300,600' rel='stylesheet' type='text/css'>
     <link href="/stylesheets/normalize.css" media="screen" rel="stylesheet" type="text/css" />
     <link href="/stylesheets/highlight.css" media="screen" rel="stylesheet" type="text/css" />
     <link href="/stylesheets/all.css" media="screen" rel="stylesheet" type="text/css" />
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
     <script src="/javascripts/all.js" type="text/javascript"></script>
     <script src="/javascripts/highlight.pack.js"></script>
+    <script src="/javascripts/sidebar-nav.js"></script>
     <script>hljs.initHighlightingOnLoad();</script>
   </head>
 
   <body>
-    {% include header.html %}
-    <article>
-
-      <section>
-        {% if page.show_masthead %}
-        <div class="masthead">
-          <img src="/images/jsonapi@1.3x.png">
-          <h1>{{ page.title }}</h1>
+     <nav class="site-nav">
+      <ul>
+        {% assign url = page.url|remove:'index.html' %}
+        {% for link in site.navigation %}
+          <li {% if url == link.url %}class="active"{% endif %}><a href="{{link.url}}" title="{{link.title}}">{{link.title}}</a></li>
+        {% endfor %}
+      </ul>
+    </nav>
+    {% if page.show_masthead %}
+      <header>
+        <div class="content">
+          <h1>JSON:API</h1>
+          <div class="quicklinks">
+            {% for link in site.quicklinks %}
+              <a href="{{link.url}}">{{link.title}}</a>
+            {% endfor %}
+          </div>
         </div>
-        {% else %}
-        <h1>{{ page.title }}</h1>
-        {% endif %}
+      </header>
+    {% endif %}
+    <div class="site-wrapper">
+      {% if page.show_sidebar %}
+        <nav class="site-content-nav" id="document-outline">
+          <h2>{{ page.title }}</h2>
+        </nav>
+      {% endif %}
+      <section class="site-content">
         {{ content }}
       </section>
-    </article>
-    {% include footer.html %}
+    </div>
+    <footer>
+      <span>Built with <a href="http://jekyllrb.com/">Jekyll</a> and <a href="http://softwaremaniacs.org/soft/highlight/en/">Highlight.js</a></span>
+      <span>Hosted by <a href="http://pages.github.com/">GitHub Pages</a></span>
+      <span>Generated at {{ site.time | date_to_xmlschema }}</span>
+    </footer>
   </body>
 </html>
diff --git a/format/index.md b/format/index.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: "Format"
+show_sidebar: true
 ---
 
 {% include status.md %}

diff --git a/images/logo.svg b/images/logo.svg
diff --git a/javascripts/sidebar-nav.js b/javascripts/sidebar-nav.js
@@ -0,0 +1,74 @@
+$(document).ready(function() {
+    var articleOutline = createOutlineFromArticle($('.site-content').eq(0));
+    var navList = createArticleNavigationFromOutline(articleOutline);
+    $("#document-outline").append(navList);
+
+    $("#document-outline li").click(function(event) {
+        $("#document-outline li").removeClass('active');
+        $(this).toggleClass('active');
+    })
+});
+
+/**
+ * Returns an array in the form of:
+ *  [{
+ *      title: "Title",
+ *      href: "#anchor",
+ *      children: [...]
+ *  }, {
+ *      title: "Title",
+ *      href: "#anchor",
+ *      children: [...]
+ *  }];
+ */
+function createOutlineFromArticle(article) {
+    var outline = [];
+
+    $('h2', article).each(function() {
+        var item = {
+            title: $(this).not('a').text(),
+            href: $(this).find('a').attr('href') || "#",
+            children: []
+        };
+
+        $(this).nextUntil('h2', 'h3').each(function() {
+            var childItem = {
+                title: $(this).not('a').text(),
+                href: $(this).find('a').attr('href') || "#",
+                children: []
+            };
+
+            item.children.push(childItem);
+        });
+
+        outline.push(item);
+    });
+
+    return outline;
+}
+
+/**
+ * Creates a nested list from an array in the form returned by `createOutlineFromArticle`.
+ */
+function createArticleNavigationFromOutline(outline) {
+    function createListFromItems(items) {
+        var ol = document.createElement('ol');
+        ol.class = "nav"
+
+        items.forEach(function(item) {
+            var a = document.createElement('a');
+            a.href = item.href;
+            a.appendChild(document.createTextNode(item.title));
+
+            var li = document.createElement('li');
+            li.appendChild(a);
+            li.appendChild(createListFromItems(item.children));
+
+            ol.appendChild(li);
+        });
+
+        return ol;
+    }
+
+    return createListFromItems(outline);
+}