Cleaning up and almost final raw design

ysonggit · Dec 27, 2012 · bc89a10 · bc89a10
1 parent bfd99fe
commit bc89a10
Show file tree

Hide file tree

Showing 12 changed files with 351 additions and 143 deletions.
diff --git a/_config.yml b/_config.yml
@@ -3,6 +3,4 @@ exclude: ['README.markdown']
 permalink: ':title'
 pygments: true
 safe: false
-url: 'htt://example.com'
-title: 'Carte'
-parent: {name: '← Return to example.com', url: 'http://example.com'}
+title: 'Carte'
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -9,8 +9,6 @@
 
   <!-- CSS -->
   <link href="/css/normalize.css" rel="stylesheet" type="text/css">
-  <link rel="stylesheet" href="http://yandex.st/highlightjs/7.3/styles/tomorrow.min.css">
-  <link href='http://fonts.googleapis.com/css?family=Imprima' rel='stylesheet' type='text/css'>
   <link href="/css/style.css" rel="stylesheet" type="text/css">
 
   <!-- Icons -->
@@ -20,22 +18,40 @@
   <link rel="apple-touch-icon" sizes="114x114" href="/images/apple-touch-icon-114x114.png">
 </head>
 <body>
-  <header id="header">
-  	<h1>{{ site.title }}</h1>
-  	<nav>
-  	  <ul>
-  	    <li><a href='{{ site.parent.url }}'>{{ site.parent.name }}</a></li>
-  	  </ul>
-  	</nav>
-  </header>
-  <div id="content">
-    {{ content }}
-  </div>
+  {{ content }}
 
   <!-- JS -->
   <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js" type="text/javascript"></script>
-  <script src="http://yandex.st/highlightjs/7.3/highlight.min.js"></script>
-  <script type="text/javascript">(function($) { hljs.initHighlightingOnLoad(); })(jQuery);</script>
+  <script type="text/javascript">
+    (function($) {
+      // Collapsible articles
+      $('article').each(function () {
+        var that = $(this);
+        var header = that.children('a');
+        var body = that.children('.body');
+        body.hide();
+        header.toggle(
+          function () { body.slideDown('fast'); that.addClass('active'); },
+          function () { body.slideUp('fast'); that.removeClass('active'); }
+        );
+      });
+
+      // Expanding the article on link click and scrolling down to it
+      $('#links a').each(function () {
+        var that = $(this);
+        that.click(function (e) {
+          e.preventDefault();
+          var that = $(this);
+          var id = that.attr('href').substring(1);
+          var header = $('article a[name="'+ id +'"]')
+          if (!header.parent().hasClass('active')) header.trigger('click');
+          $('html, body').animate({
+            scrollTop: header.offset().top
+          }, 'fast');
+        });
+      });
+    })(jQuery);
+  </script>
   <!--[if lt IE 9]>
 		<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
 	<![endif]-->

diff --git a/_posts/2012-12-24-delete-a-thing.md b/_posts/2012-12-24-delete-a-thing.md
@@ -0,0 +1,28 @@
+---
+path: '/stuff/:id'
+title: 'Delete a thing'
+type: 'DELETE'
+parameters:
+- name: 'id'
+  description: 'the id of the thing to delete.'
+
+layout: nil
+---
+
+This method allows the user to post a new thing to his stuff.
+
+### Request
+
+* Authentication is required.
+* The body is omitted.
+
+### Response
+
+Sends back a collection of things.
+
+```Status: 200 Deleted```
+
+```{
+    code: 200,
+    message: 'Your thing (id: 736) was deleted'
+}```
diff --git a/_posts/2012-12-25-post-a-thing.md b/_posts/2012-12-25-post-a-thing.md
diff --git a/_posts/2012-12-25-put-a-thing.md b/_posts/2012-12-25-put-a-thing.md
@@ -0,0 +1,43 @@
+---
+path: '/stuff/:id'
+title: 'Update a thing'
+type: 'PUT'
+
+layout: post
+---
+
+This method allows the user to retrieve his stuff.
+
+### Request
+
+#### Requirements
+
+* **URL**: `:id` is the id the thing to update.'
+* **Header**: Valid authentication token.
+* **Body**: can't be empty and must include at least **name**, a `string` that will be used as the name of the thing.
+
+#### Sample
+
+```Authentication: bearer f862f658-ad89-4fcb-995b-7a4c50554ff6```
+```{
+    name: 'My new thing'
+}```
+
+### Response
+
+Sends back a collection of things.
+
+```Status: 200 OK```
+
+```{
+    {
+        id: thing_1,
+        name: 'My first thing'
+    },
+    {
+        id: thing_2,
+        name: 'My second thing'
+    }
+}```
+
+For errors, see the [code]
diff --git a/_posts/2012-12-26-get-stuff.md b/_posts/2012-12-26-get-stuff.md
diff --git a/_posts/2012-12-26-post-a-thing.md b/_posts/2012-12-26-post-a-thing.md
@@ -0,0 +1,32 @@
+---
+path: '/stuff'
+title: 'Post a thing'
+type: 'POST'
+
+layout: post
+---
+
+This method allows users to crate a new thing.
+
+### Request
+
+Expects a fully formed thing object.
+
+```Authentication: bearer TOKEN```
+
+```{
+    name: 'My new thing'
+}```
+
+### Response
+
+**If succeeds**, returns the created thing.
+
+```Status: 201 Created```
+
+```{
+    id: new_thing,
+    name: 'My new thing'
+}```
+
+ERROR
diff --git a/_posts/2012-12-27-get-stuff.md b/_posts/2012-12-27-get-stuff.md
@@ -0,0 +1,28 @@
+---
+path: '/stuff'
+title: 'Get stuff'
+type: 'GET'
+
+layout: post
+---
+
+This method allows users to retrieve stuff.
+
+### Response
+
+Sends back a collection of things.
+
+```Status: 200 OK```
+
+```{
+    {
+        id: thing_1,
+        name: 'My first thing'
+    },
+    {
+        id: thing_2,
+        name: 'My second thing'
+    }
+}```
+
+ERROR
diff --git a/_posts/2012-12-28-authentication.md b/_posts/2012-12-28-authentication.md
@@ -0,0 +1,19 @@
+---
+path: '/login'
+title: 'Authenticate'
+
+layout: post
+---
+
+This method allows users to retrieve stuff.
+
+### Response
+
+Sends back a collection of things.
+
+```Authentication: bearer TOKEN```
+
+```{
+    id: thing_2,
+    name: 'My second thing'
+}```
diff --git a/_posts/2012-12-28-response-status-codes.md b/_posts/2012-12-28-response-status-codes.md
@@ -0,0 +1,16 @@
+---
+title: 'Response status codes'
+
+layout: nil
+---
+
+### Success
+
+### Error
+
+```Status: 401 Access denied```
+
+```{
+    code: 401,
+    message: 'Access denied: invalid authentication token.'
+}```