Skip to content

Commit 3e81af6

Browse files
lordlord
committed
Site updated to c5381c6 
1 parent ee019e7 commit 3e81af6

13 files changed

Lines changed: 137 additions & 70 deletions

File tree

‎images/navbar.png‎

2.72 KB
Loading

‎index.html‎

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
<head>
44
<meta charset="utf-8">
55
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
6+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
67
<title>API Reference</title>
78

89
<link href="stylesheets/screen.css" rel="stylesheet" type="text/css" media="screen" />
910
<link href="stylesheets/print.css" rel="stylesheet" type="text/css" media="print" />
1011
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
11-
<script src="javascripts/all.js" type="text/javascript"></script>
12+
<script src="javascripts/all.js" type="text/javascript"></script>
1213

1314
<script>
1415
$(function() {
@@ -18,12 +19,23 @@
1819
</head>
1920

2021
<body class="index">
22+
<a href="#" id="nav-button">
23+
<span>
24+
NAV
25+
<img src="images/navbar.png" />
26+
</span>
27+
</a>
2128
<div class="tocify-wrapper">
2229
<img src="images/logo.png" />
30+
<div class="lang-selector">
31+
<a href="#" data-language-name="shell">shell</a>
32+
<a href="#" data-language-name="ruby">ruby</a>
33+
<a href="#" data-language-name="python">python</a>
34+
</div>
2335
<div class="search">
24-
<input type="text" class="search" id="input-search">
36+
<input type="text" class="search" id="input-search" placeholder="Search">
2537
</div>
26-
<div class="search-info"></div>
38+
<ul class="search-results"></ul>
2739
<div id="toc">
2840
</div>
2941
<ul class="toc-footer">
@@ -34,16 +46,13 @@
3446
<div class="page-wrapper">
3547
<div class="dark-box"></div>
3648
<div class="content">
37-
<h1 id="introduction">Introduction</h1>
38-
49+
<h1 id='introduction'>Introduction</h1>
3950
<p>Welcome to the Kittn API! You can use our API to access Kittn API endpoints, which can get information on various cats, kittens, and breeds in our database.</p>
4051

4152
<p>We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.</p>
4253

4354
<p>This example API documentation page was created with <a href="http://github.com/tripit/slate">Slate</a>. Feel free to edit it and use it as a base for your own API&rsquo;s documentation.</p>
44-
45-
<h1 id="authentication">Authentication</h1>
46-
55+
<h1 id='authentication'>Authentication</h1>
4756
<blockquote>
4857
<p>To authorize, use this code:</p>
4958
</blockquote>
@@ -73,11 +82,7 @@ <h1 id="authentication">Authentication</h1>
7382
<p><aside class="notice">
7483
You must replace <code class="prettyprint">meowmeowmeow</code> with your personal API key.
7584
</aside></p>
76-
77-
<h1 id="kittens">Kittens</h1>
78-
79-
<h2 id="get-all-kittens">Get All Kittens</h2>
80-
<pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'kittn'</span>
85+
<h1 id='kittens'>Kittens</h1><h2 id='get-all-kittens'>Get All Kittens</h1><pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'kittn'</span>
8186

8287
<span class="n">api</span> <span class="o">=</span> <span class="no">Kittn</span><span class="o">::</span><span class="no">APIClient</span><span class="p">.</span><span class="nf">authorize!</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">)</span>
8388
<span class="n">api</span><span class="p">.</span><span class="nf">kittens</span><span class="p">.</span><span class="nf">get</span>
@@ -113,13 +118,9 @@ <h2 id="get-all-kittens">Get All Kittens</h2>
113118
</span></pre>
114119

115120
<p>This endpoint retrieves all kittens.</p>
116-
117-
<h3 id="http-request">HTTP Request</h3>
118-
121+
<h3 id='http-request'>HTTP Request</h1>
119122
<p><code class="prettyprint">GET http://example.com/kittens</code></p>
120-
121-
<h3 id="query-parameters">Query Parameters</h3>
122-
123+
<h3 id='query-parameters'>Query Parameters</h1>
123124
<table><thead>
124125
<tr>
125126
<th>Parameter</th>
@@ -142,9 +143,7 @@ <h3 id="query-parameters">Query Parameters</h3>
142143
<p><aside class="success">
143144
Remember — a happy kitten is an authenticated kitten!
144145
</aside></p>
145-
146-
<h2 id="get-a-specific-kitten">Get a Specific Kitten</h2>
147-
<pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'kittn'</span>
146+
<h2 id='get-a-specific-kitten'>Get a Specific Kitten</h1><pre class="highlight ruby"><span class="nb">require</span> <span class="s1">'kittn'</span>
148147

149148
<span class="n">api</span> <span class="o">=</span> <span class="no">Kittn</span><span class="o">::</span><span class="no">APIClient</span><span class="p">.</span><span class="nf">authorize!</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">)</span>
150149
<span class="n">api</span><span class="p">.</span><span class="nf">kittens</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
@@ -173,13 +172,9 @@ <h2 id="get-a-specific-kitten">Get a Specific Kitten</h2>
173172
<p>This endpoint retrieves a specific kitten.</p>
174173

175174
<p><aside class="warning">If you&rsquo;re not using an administrator API key, note that some kittens will return 403 Forbidden if they are hidden for admins only.</aside></p>
176-
177-
<h3 id="http-request">HTTP Request</h3>
178-
175+
<h3 id='http-request'>HTTP Request</h1>
179176
<p><code class="prettyprint">GET http://example.com/kittens/&lt;ID&gt;</code></p>
180-
181-
<h3 id="url-parameters">URL Parameters</h3>
182-
177+
<h3 id='url-parameters'>URL Parameters</h1>
183178
<table><thead>
184179
<tr>
185180
<th>Parameter</th>
@@ -192,8 +187,7 @@ <h3 id="url-parameters">URL Parameters</h3>
192187
</tr>
193188
</tbody></table>
194189

195-
<h1 id="errors">Errors</h1>
196-
190+
<h1 id='errors'>Errors</h1>
197191
<p><aside class="notice">This error section is stored in a separate file in <code class="prettyprint">includes/_errors.md</code>. Slate allows you to optionally separate out your docs into many files&hellip;just save them to the <code class="prettyprint">includes</code> folder and add them to the top of your <code class="prettyprint">index.md</code>&rsquo;s frontmatter. Files are included in the order listed.</aside></p>
198192

199193
<p>The Kittn API uses the following error codes:</p>
@@ -252,7 +246,7 @@ <h1 id="errors">Errors</h1>
252246

253247
</div>
254248
<div class="dark-box">
255-
<div id="lang-selector">
249+
<div class="lang-selector">
256250
<a href="#" data-language-name="shell">shell</a>
257251
<a href="#" data-language-name="ruby">ruby</a>
258252
<a href="#" data-language-name="python">python</a>

‎javascripts/all.js‎

Lines changed: 18 additions & 18 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎javascripts/all_nosearch.js‎

Lines changed: 72 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎javascripts/app/lang.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
1313
License for the specific language governing permissions and limitations
1414
under the License.
1515
*/
16-
!function(t){function e(t){if(t){$("#lang-selector a").removeClass("active"),$("#lang-selector a[data-language-name='"+t+"']").addClass("active");for(var e=0;e<o.length;e++)$(".highlight."+o[e]).hide();$(".highlight."+t).show(),$(window.location.hash).get(0).scrollIntoView(!0)}}function i(t){if(history){var e=window.location.hash;e&&(e=e.replace(/^#+/,"")),history.pushState({},"","?"+t+"#"+e)}}function n(t){var i=(t[0],localStorage.getItem("language"));o=t,""!==location.search.substr(1)&&-1!=jQuery.inArray(location.search.substr(1),o)?(e(location.search.substr(1)),localStorage.setItem("language",location.search.substr(1))):e(null!==i&&-1!=jQuery.inArray(i,o)?i:o[0])}var o=[];t.setupLanguages=n,t.activateLanguage=e,$(function(){$("#lang-selector a").on("click",function(){var t=$(this).data("language-name");return i(t),e(t),!1}),window.onpopstate=function(){e(window.location.search.substr(1))}})}(window);
16+
!function(t){function e(t){if(t&&""!==t){$(".lang-selector a").removeClass("active"),$(".lang-selector a[data-language-name='"+t+"']").addClass("active");for(var e=0;e<o.length;e++)$(".highlight."+o[e]).hide();$(".highlight."+t).show(),$(window.location.hash).get(0).scrollIntoView(!0)}}function i(t){if(history){var e=window.location.hash;e&&(e=e.replace(/^#+/,"")),history.pushState({},"","?"+t+"#"+e),localStorage.setItem("language",t)}}function n(t){var i=(t[0],localStorage.getItem("language"));o=t,""!==location.search.substr(1)&&-1!=jQuery.inArray(location.search.substr(1),o)?(e(location.search.substr(1)),localStorage.setItem("language",location.search.substr(1))):e(null!==i&&-1!=jQuery.inArray(i,o)?i:o[0])}var o=[];t.setupLanguages=n,t.activateLanguage=e,$(function(){$(".lang-selector a").on("click",function(){var t=$(this).data("language-name");return i(t),e(t),!1}),window.onpopstate=function(){e(window.location.search.substr(1))}})}(window);

‎javascripts/app/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎javascripts/app/toc.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎javascripts/lib/energize.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)