UNPKG

3.66 kBHTMLView Raw
1<!DOCTYPE html>
2<html>
3 <head>
4 <meta charset='UTF-8'>
5 <title>CoffeeScript API Documentation</title>
6 <link rel='stylesheet' href='assets/codo.css' type='text/css'>
7 <script src='assets/codo.js'></script>
8 <script src='assets/search_data.js'></script>
9</head>
10 <body>
11 <div id='base' data-path=''></div>
12<div id='header'>
13 <div id='menu'>
14 <a href='README.md.html' title='Archive.org'>Archive.org</a>
15 &raquo;
16 <a href='class_index.html' title='Index'>Index</a>
17 &raquo;
18 <span class='title'>README.md</span>
19 <nav>
20 <ul>
21 <li class='noframes'>
22 (<a class='noframes' href='#'>no frames</a>)
23 </li>
24 </ul>
25 </nav>
26 <div id='search'>
27 <a id='class_list_link' href='class_list.html'>Classes</a>
28 <a id='method_list_link' href='method_list.html'>Methods</a>
29 <a id='extra_list_link' href='extra_list.html'>Extras</a>
30 </div>
31 </div>
32 <iframe id='search_frame'></iframe>
33 <div id='fuzzySearch'>
34 <input type='text'>
35 <ol></ol>
36 </div>
37 <div id='help'>
38 <p>
39 Quickly fuzzy find classes, mixins, methods, file:
40 </p>
41 <ul>
42 <li>
43 <span>Ctrl-T</span>
44 Open fuzzy finder dialog
45 </li>
46 </ul>
47 <p>
48 In frame mode you can toggle the list naviation frame on the left side:
49 </p>
50 <ul>
51 <li>
52 <span>Ctrl-L</span>
53 Toggle list view
54 </li>
55 </ul>
56 <p>
57 You can focus a list in frame mode or toggle a tab in frameless mode:
58 </p>
59 <ul>
60 <li>
61 <span>Ctrl-C</span>
62 Class list
63 </li>
64 <li>
65 <span>Ctrl-I</span>
66 Mixin list
67 </li>
68 <li>
69 <span>Ctrl-F</span>
70 File list
71 </li>
72 <li>
73 <span>Ctrl-M</span>
74 Method list
75 </li>
76 <li>
77 <span>Ctrl-E</span>
78 Extras list
79 </li>
80 </ul>
81 <p>
82 You can focus and blur the search input:
83 </p>
84 <ul>
85 <li>
86 <span>Ctrl-S</span>
87 Focus search input
88 </li>
89 <li>
90 <span>Esc</span>
91 Blur search input
92 </li>
93 </ul>
94 <p>
95 In frameless mode you can close the list tab:
96 </p>
97 <ul>
98 <li>
99 <span>Esc</span>
100 Close list tab
101 </li>
102 </ul>
103 </div>
104</div>
105 <div id='content'>
106 <nav class='toc'>
107 <p class='title'>
108 <a class='hide_toc' href='#'>
109 <strong>Table of Contents</strong>
110 </a>
111 <small>
112 (<a class='float_toc' href='#'>left</a>)
113 </small>
114 </p>
115 </nav>
116 <div id='filecontents'>
117 <h1>archive.org</h1><p>npm module for the subsonic api</p><p><a href="http://travis-ci.org/switz/archive.org"><img src="https://secure.travis-ci.org/switz/archive.org.png" alt="build status"></a></p><h3>Install</h3>
118<pre><code>$ npm install archive.org --save</code></pre>
119<h3>Docs</h3><p><a href="http://saewitz.com/subsonic/doc/classes/Archive.html">Documentation</a></p><h3>Example</h3>
120<pre><code class="lang-javascript">Archive = require(&#39;archive.org&#39;);
121archive = new Archive();
122
123archive.search({q: &#39;Grateful Dead&#39;}, function(err, res) {
124 console.log(res);
125});</code></pre>
126
127 </div>
128 </div>
129 <div id='footer'>
130 Generated on
131 Sat Mar 30 2013 20:18:24 GMT-0400 (EDT)
132 by
133 <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
134 v1.5.6
135 (Node.js v0.8.22).
136 &#10034;
137 Press Ctrl-h to see the keyboard shortcuts
138 &#10034;
139 <a href='http://twitter.com/#!/netzpirat'>@netzpirat</a>
140 &#10034;
141 <a href='https://mksoft.ch'>mksoft.ch</a>
142</div>
143 </body>
144</html>
\No newline at end of file