json-api · dgeb · May 19, 2015 · Mar 27, 2015 · Mar 27, 2015 · Mar 29, 2015
diff --git a/Gemfile b/Gemfile
@@ -6,7 +6,7 @@ gem "rake", "~> 10.0"
 gem "jekyll", "~> 1.0"
 gem "redcarpet", "~> 2.2"
 gem "rb-fsevent", "~> 0.9"
-gem "compass", "~> 0.12"
-gem "sass", "~> 3.2"
+gem "compass", "~> 1.0"
+gem "sass", "~> 3.4"
 gem "launchy", "~> 2.3"
 gem "redcard", "~> 1.0"
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: View the specification
+  url: /format/
+- title: Contribute on Github
+  url: https://github.com/json-api/json-api
diff --git a/_includes/footer.html b/_includes/footer.html
diff --git a/_includes/header.html b/_includes/header.html
diff --git a/_layouts/page.html b/_layouts/page.html
@@ -2,38 +2,81 @@
 <html>
   <head>
     <meta charset="utf-8">
-
-    <!-- Always force latest IE rendering engine or request Chrome Frame -->
     <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
-
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
     <!-- 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'>
+    <title>JSON:API - {{ page.title }}</title>
+
+    <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>hljs.initHighlightingOnLoad();</script>
   </head>
 
   <body>
-    {% include header.html %}
-    <article>
+     <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>
+          <h2>A standard for building APIs in JSON.</h2>
 
-      <section>
-        {% if page.show_masthead %}
-        <div class="masthead">
-          <img src="/images/jsonapi@1.3x.png">
-          <h1>{{ page.title }}</h1>
+          <div class="quicklinks">
+            {% for link in site.quicklinks %}
+              <a href="{{link.url}}" title="{{link.title}}">{{link.title}}</a>
+            {% endfor %}
+          </div>
+        </div>
+      </header>
+    {% endif %}
+    <div class="site-wrapper">
+      {% if page.show_sidebar %}
+        <div class="sidebar">
+          <nav class="document-outline" id="document-outline">
+            <h1>{{ page.title }}</h1>
+          </nav>
         </div>
-        {% else %}
-        <h1>{{ page.title }}</h1>
-        {% endif %}
-        {{ content }}
-      </section>
-    </article>
-    {% include footer.html %}
+      {% endif %}
+      <div class="content">
+        {% unless page.show_masthead %}
+          <h1>{{ page.title }}</h1>
+        {% endunless %}
+        <section>
+          {{ content }}
+        </section>
+      </div>
+    </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>
+      <span class="social-links">
+        <a class="twitter" href="http://twitter.com/jsonapi"><i class="icon-twitter"></i><span>Twitter</span></a>
+        <a class="github" href="https://github.com/json-api"><i class="icon-github"></i><span>GitHub</span></a>
+        <a class="googleplus" href="https://groups.google.com/forum/?fromgroups#!forum/jsonapi"><i class="icon-gplus"></i><span>Google</span></a>
+      </span>
+    </footer>
+    <script>
+      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+      ga('create', 'UA-40609539-1', 'jsonapi.org');
+      ga('send', 'pageview');
+
+    </script>
   </body>
 </html>
diff --git a/design/jsonapi.sketch b/design/jsonapi.sketch
diff --git a/design/jsonapi.sketch/Data b/design/jsonapi.sketch/Data
diff --git a/design/jsonapi.sketch/metadata b/design/jsonapi.sketch/metadata
diff --git a/design/jsonapi.sketch/version b/design/jsonapi.sketch/version
diff --git a/extensions/index.md b/extensions/index.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Extensions
+show_sidebar: true
 ---
 
 JSON API can be extended in several ways:

diff --git a/faq/index.md b/faq/index.md
@@ -3,13 +3,13 @@ layout: page
 title: Frequently Asked Questions
 ---
 
-### Why is JSON API not versioned? <a href="#why-is-json-api-not-versioned" id="why-is-json-api-not-versioned" class="headerlink"></a>
+## Why is JSON API not versioned? <a href="#why-is-json-api-not-versioned" id="why-is-json-api-not-versioned" class="headerlink"></a>
 
 Once JSON API is stable, it will always be backwards compatible using a _never
 remove, only add_ strategy.
 [#46](https://github.com/json-api/json-api/issues/46)
 
-### Why not use the HAL specification? <a href="#why-not-use-the-hal-specification" id="why-not-use-the-hal-specification" class="headerlink"></a>
+## Why not use the HAL specification? <a href="#why-not-use-the-hal-specification" id="why-not-use-the-hal-specification" class="headerlink"></a>
 
 There are several reasons:
 
@@ -37,7 +37,7 @@ It is extracted from a real-world library already used by a number of projects,
 which has informed both the request/response aspects (absent from HAL) and the
 interchange format itself.
 
-### How to discover resource possible actions? <a href="#how-to-discover-resource-possible-actions" id="how-to-discover-resource-possible-actions" class="headerlink"></a>
+## How to discover resource possible actions? <a href="#how-to-discover-resource-possible-actions" id="how-to-discover-resource-possible-actions" class="headerlink"></a>
 
 You should use the OPTIONS HTTP method to discover what can be done with a
 particular resource. The semantics of the methods returned by OPTIONS is defined
@@ -52,19 +52,19 @@ and capabilities and use the errors response to let users know. This error featu
 is still pending to be included in the standard since is still in
 [discussion](https://github.com/json-api/json-api/issues/7).
 
-### Where's PUT? Can I use method *X* to do *Y*? <a href="#wheres-put" id="wheres-put" class="headerlink"></a>
+## Where's PUT? Can I use method *X* to do *Y*? <a href="#wheres-put" id="wheres-put" class="headerlink"></a>
 
 JSON API does not currently specify the use of the `PUT` method for any purpose.
 
 Servers may complement the base specification by providing extra capabilities and
 alternative ways of requesting certain operations (e.g., resource creation via
 `PUT` in addition to `POST`).
 
-### Is there a JSON Schema describing JSON API? <a href="#is-there-a-json-schema-describing-json-api" id="is-there-a-json-schema-describing-json-api" class="headerlink"></a>
+## Is there a JSON Schema describing JSON API? <a href="#is-there-a-json-schema-describing-json-api" id="is-there-a-json-schema-describing-json-api" class="headerlink"></a>
 
 Not currently, no. JSON Schema cannot fully represent the semantics of JSON API, and so any such schema would be partial anyway.
 
-### Why are resource collections returned as arrays instead of sets keyed by ID?
+## Why are resource collections returned as arrays instead of sets keyed by ID?
 
 A JSON array is naturally ordered while sets require metadata to specify order
 among members. Therefore, arrays allow for more natural sorting by default or
@@ -73,14 +73,14 @@ specified criteria.
 In addition, JSON API allows read-only resources to be returned without IDs,
 which would of course be incompatible with a set keyed by IDs.
 
-### Why are related resources nested in an `included` object in a compound document?
+## Why are related resources nested in an `included` object in a compound document?
 
 Primary resources should be isolated because their order and number is often
 significant. It's necessary to separate primary and related resources by more
 than type because it's possible that a primary resource may have related
 resources of the same type (e.g. the "parents" of a "person"). Nesting related
 resources in `included` prevents this possible conflict.
 
-### Does JSON API take any position on URI structure, on rules for custom endpoints, which do not fit the paradigm of GET/POST/PATCH/DELETE on the resource URI, etc.?
+## Does JSON API take any position on URI structure, on rules for custom endpoints, which do not fit the paradigm of GET/POST/PATCH/DELETE on the resource URI, etc.?
 
 JSON API has no requirements about URI structure, implementations are free to use whatever form they wish.
diff --git a/format/index.md b/format/index.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: "Format"
+show_sidebar: true
 ---
 
 {% include status.md %}
@@ -18,34 +19,6 @@ JSON API requires use of the JSON API media type
 ([`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json))
 for exchanging data.
 
-**Table of Contents**
-
-- [Status](#status)
-- [Introduction](#introduction)
-- [Conventions](#conventions)
-- [Extending](#extending)
-- [Document Structure](#document-structure)
-  - [Top Level](#document-structure-top-level)
-  - [Resource Objects](#document-structure-resource-objects)
-  - [Compound Documents](#document-structure-compound-documents)
-  - [Meta information](#document-structure-meta)
-  - [Links](#document-structure-links)
-  - [Member names](#document-structure-member-names)
-- [Fetching Data](#fetching)
-  - [Fetching Resources](#fetching-resources)
-  - [Fetching Relationships](#fetching-relationships)
-  - [Inclusion of Related Resources](#fetching-includes)
-  - [Sparse Fieldsets](#fetching-sparse-fieldsets)
-  - [Sorting](#fetching-sorting)
-  - [Pagination](#fetching-pagination)
-  - [Filtering](#fetching-filtering)
-- [Creating, Updating and Deleting Resources](#crud)
-  - [Creating Resources](#crud-creating)
-  - [Updating Resources](#crud-updating)
-  - [Updating Relationships](#crud-updating-relationships)
-  - [Deleting Resources](#crud-deleting)
-- [Errors](#errors)
-
 ## Conventions <a href="#conventions" id="conventions" class="headerlink"></a>
 
 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",

diff --git a/images/jsonapi.png b/images/jsonapi.png
diff --git a/images/jsonapi@0.7x.png b/images/jsonapi@0.7x.png
diff --git a/images/jsonapi@1.3x.png b/images/jsonapi@1.3x.png
diff --git a/implementations/index.md b/implementations/index.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: Implementations
+show_sidebar: true
 ---
 
 The following are projects implementing JSON API. If you'd like your project listed, [send a

diff --git a/index.md b/index.md
@@ -1,6 +1,6 @@
 ---
 layout: page
-title: "A standard for building APIs in JSON."
+title: "A standard for building APIs in JSON"
 show_masthead: true
 ---