apiaryio 0.0.8 → 0.0.9
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +1 -0
- data/.travis.yml +3 -4
- data/Gemfile +5 -0
- data/README.md +6 -2
- data/apiary.gemspec +4 -3
- data/doc/Apiary.html +7 -7
- data/doc/Apiary/CLI.html +44 -32
- data/doc/Apiary/Command.html +7 -7
- data/doc/Apiary/Command/Fetch.html +572 -0
- data/doc/Apiary/Command/Help.html +16 -11
- data/doc/Apiary/Command/Preview.html +175 -216
- data/doc/Apiary/Command/Publish.html +634 -0
- data/doc/Apiary/Command/Runner.html +8 -9
- data/doc/Apiary/Command/Version.html +7 -8
- data/doc/_index.html +28 -6
- data/doc/class_list.html +3 -2
- data/doc/css/style.css +11 -1
- data/doc/file.README.html +37 -22
- data/doc/file_list.html +2 -1
- data/doc/frames.html +5 -7
- data/doc/index.html +37 -22
- data/doc/js/app.js +7 -2
- data/doc/js/full_list.js +7 -2
- data/doc/method_list.html +112 -89
- data/doc/top-level-namespace.html +5 -5
- data/lib/apiary/command/fetch.rb +79 -0
- data/lib/apiary/command/help.rb +1 -0
- data/lib/apiary/version.rb +1 -1
- data/spec/command/fetch_spec.rb +87 -0
- data/spec/spec_helper.rb +1 -0
- metadata +121 -85
@@ -6,13 +6,13 @@
|
|
6
6
|
<title>
|
7
7
|
Class: Apiary::Command::Runner
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.7.3
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="../../css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="../../css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
18
|
hasFrames = window.top.frames.main ? true : false;
|
@@ -101,9 +101,8 @@
|
|
101
101
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
|
-
|
105
|
-
Run commands
|
106
|
-
</p>
|
104
|
+
|
105
|
+
<p>Run commands</p>
|
107
106
|
|
108
107
|
|
109
108
|
</div>
|
@@ -180,7 +179,7 @@ Run commands
|
|
180
179
|
<pre class="code"><span class="info file"># File 'lib/apiary/command/runner.rb', line 7</span>
|
181
180
|
|
182
181
|
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
183
|
-
<span class='const'>Apiary</span><span class='op'>::</span><span class='const'>Command</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:execute</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
182
|
+
<span class='const'>Apiary</span><span class='op'>::</span><span class='const'>Command</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:execute</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
184
183
|
<span class='kw'>end</span></pre>
|
185
184
|
</td>
|
186
185
|
</tr>
|
@@ -192,9 +191,9 @@ Run commands
|
|
192
191
|
</div>
|
193
192
|
|
194
193
|
<div id="footer">
|
195
|
-
Generated on
|
194
|
+
Generated on Sat Jan 25 12:41:41 2014 by
|
196
195
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
197
|
-
0.8.
|
196
|
+
0.8.7.3 (ruby-2.1.0).
|
198
197
|
</div>
|
199
198
|
|
200
199
|
</body>
|
@@ -6,13 +6,13 @@
|
|
6
6
|
<title>
|
7
7
|
Class: Apiary::Command::Version
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.7.3
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="../../css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="../../css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
18
|
hasFrames = window.top.frames.main ? true : false;
|
@@ -101,9 +101,8 @@
|
|
101
101
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
|
-
|
105
|
-
Display version
|
106
|
-
</p>
|
104
|
+
|
105
|
+
<p>Display version</p>
|
107
106
|
|
108
107
|
|
109
108
|
</div>
|
@@ -192,9 +191,9 @@ Display version
|
|
192
191
|
</div>
|
193
192
|
|
194
193
|
<div id="footer">
|
195
|
-
Generated on
|
194
|
+
Generated on Sat Jan 25 12:41:41 2014 by
|
196
195
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
197
|
-
0.8.
|
196
|
+
0.8.7.3 (ruby-2.1.0).
|
198
197
|
</div>
|
199
198
|
|
200
199
|
</body>
|
data/doc/_index.html
CHANGED
@@ -4,13 +4,13 @@
|
|
4
4
|
<head>
|
5
5
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
6
|
<title>
|
7
|
-
Documentation by YARD 0.8.
|
7
|
+
Documentation by YARD 0.8.7.3
|
8
8
|
|
9
9
|
</title>
|
10
10
|
|
11
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
11
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
14
14
|
|
15
15
|
<script type="text/javascript" charset="utf-8">
|
16
16
|
hasFrames = window.top.frames.main ? true : false;
|
@@ -56,7 +56,7 @@
|
|
56
56
|
|
57
57
|
<iframe id="search_frame"></iframe>
|
58
58
|
|
59
|
-
<div id="content"><h1 class="noborder title">Documentation by YARD 0.8.
|
59
|
+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.8.7.3</h1>
|
60
60
|
<div id="listing">
|
61
61
|
<h1 class="alphaindex">Alphabetic Index</h1>
|
62
62
|
|
@@ -115,6 +115,21 @@
|
|
115
115
|
</ul>
|
116
116
|
|
117
117
|
|
118
|
+
<ul id="alpha_F" class="alpha">
|
119
|
+
<li class="letter">F</li>
|
120
|
+
<ul>
|
121
|
+
|
122
|
+
<li>
|
123
|
+
<span class='object_link'><a href="Apiary/Command/Fetch.html" title="Apiary::Command::Fetch (class)">Fetch</a></span>
|
124
|
+
|
125
|
+
<small>(Apiary::Command)</small>
|
126
|
+
|
127
|
+
</li>
|
128
|
+
|
129
|
+
</ul>
|
130
|
+
</ul>
|
131
|
+
|
132
|
+
|
118
133
|
<ul id="alpha_H" class="alpha">
|
119
134
|
<li class="letter">H</li>
|
120
135
|
<ul>
|
@@ -141,6 +156,13 @@
|
|
141
156
|
|
142
157
|
</li>
|
143
158
|
|
159
|
+
<li>
|
160
|
+
<span class='object_link'><a href="Apiary/Command/Publish.html" title="Apiary::Command::Publish (class)">Publish</a></span>
|
161
|
+
|
162
|
+
<small>(Apiary::Command)</small>
|
163
|
+
|
164
|
+
</li>
|
165
|
+
|
144
166
|
</ul>
|
145
167
|
</ul>
|
146
168
|
|
@@ -183,9 +205,9 @@
|
|
183
205
|
</div>
|
184
206
|
|
185
207
|
<div id="footer">
|
186
|
-
Generated on
|
208
|
+
Generated on Sat Jan 25 12:41:41 2014 by
|
187
209
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
188
|
-
0.8.
|
210
|
+
0.8.7.3 (ruby-2.1.0).
|
189
211
|
</div>
|
190
212
|
|
191
213
|
</body>
|
data/doc/class_list.html
CHANGED
@@ -15,6 +15,7 @@
|
|
15
15
|
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
16
|
|
17
17
|
|
18
|
+
<title>Class List</title>
|
18
19
|
<base id="base_target" target="_parent" />
|
19
20
|
</head>
|
20
21
|
<body>
|
@@ -44,8 +45,8 @@
|
|
44
45
|
<div id="search">Search: <input type="text" /></div>
|
45
46
|
|
46
47
|
<ul id="full_list" class="class">
|
47
|
-
<li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
|
48
|
-
<li><a class='toggle'></a> <span class='object_link'><a href="Apiary.html" title="Apiary (module)">Apiary</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Apiary/CLI.html" title="Apiary::CLI (class)">CLI</a></span> < Object<small class='search_info'>Apiary</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Apiary/Command.html" title="Apiary::Command (module)">Command</a></span><small class='search_info'>Apiary</small></li><ul><li><span class='object_link'><a href="Apiary/Command/Help.html" title="Apiary::Command::Help (class)">Help</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Preview.html" title="Apiary::Command::Preview (class)">Preview</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Runner.html" title="Apiary::Command::Runner (class)">Runner</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Version.html" title="Apiary::Command::Version (class)">Version</a></span> < Object<small class='search_info'>Apiary::Command</small></li></ul></ul>
|
48
|
+
<li><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></li>
|
49
|
+
<li><a class='toggle'></a> <span class='object_link'><a href="Apiary.html" title="Apiary (module)">Apiary</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Apiary/CLI.html" title="Apiary::CLI (class)">CLI</a></span> < Object<small class='search_info'>Apiary</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Apiary/Command.html" title="Apiary::Command (module)">Command</a></span><small class='search_info'>Apiary</small></li><ul><li><span class='object_link'><a href="Apiary/Command/Fetch.html" title="Apiary::Command::Fetch (class)">Fetch</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Help.html" title="Apiary::Command::Help (class)">Help</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Preview.html" title="Apiary::Command::Preview (class)">Preview</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Publish.html" title="Apiary::Command::Publish (class)">Publish</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Runner.html" title="Apiary::Command::Runner (class)">Runner</a></span> < Object<small class='search_info'>Apiary::Command</small></li><li><span class='object_link'><a href="Apiary/Command/Version.html" title="Apiary::Command::Version (class)">Version</a></span> < Object<small class='search_info'>Apiary::Command</small></li></ul></ul>
|
49
50
|
|
50
51
|
</ul>
|
51
52
|
</div>
|
data/doc/css/style.css
CHANGED
@@ -27,6 +27,16 @@ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right;
|
|
27
27
|
.rdoc-term { padding-right: 25px; font-weight: bold; }
|
28
28
|
.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
|
29
29
|
|
30
|
+
/* style for <table> */
|
31
|
+
#filecontents table, .docstring table { border-collapse: collapse; }
|
32
|
+
#filecontents table th, #filecontents table td,
|
33
|
+
.docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; }
|
34
|
+
#filecontents table tr:nth-child(odd),
|
35
|
+
.docstring table tr:nth-child(odd) { background: #eee; }
|
36
|
+
#filecontents table tr:nth-child(even),
|
37
|
+
.docstring table tr:nth-child(even) { background: #fff; }
|
38
|
+
#filecontents table th, .docstring table th { background: #fff; }
|
39
|
+
|
30
40
|
/* style for <ul> */
|
31
41
|
#filecontents li > p, .docstring li > p { margin: 0px; }
|
32
42
|
#filecontents ul, .docstring ul { padding-left: 20px; }
|
@@ -314,9 +324,9 @@ pre.code .dot + pre.code .id,
|
|
314
324
|
pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
|
315
325
|
pre.code .comment { color: #0066FF; }
|
316
326
|
pre.code .const, pre.code .constant { color: #585CF6; }
|
327
|
+
pre.code .label,
|
317
328
|
pre.code .symbol { color: #C5060B; }
|
318
329
|
pre.code .kw,
|
319
|
-
pre.code .label,
|
320
330
|
pre.code .rubyid_require,
|
321
331
|
pre.code .rubyid_extend,
|
322
332
|
pre.code .rubyid_include { color: #0000FF; }
|
data/doc/file.README.html
CHANGED
@@ -6,13 +6,13 @@
|
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.7.3
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
18
|
hasFrames = window.top.frames.main ? true : false;
|
@@ -61,30 +61,29 @@
|
|
61
61
|
|
62
62
|
<iframe id="search_frame"></iframe>
|
63
63
|
|
64
|
-
<div id="content"><div id='filecontents'
|
64
|
+
<div id="content"><div id='filecontents'>
|
65
|
+
<h1 id="label-apiaryio">apiaryio</h1>
|
65
66
|
|
66
67
|
<p>Apiary.io CLI</p>
|
67
68
|
|
68
|
-
<
|
69
|
+
<p><a href="https://travis-ci.org/apiaryio/apiary-client"><img
|
70
|
+
src="https://travis-ci.org/apiaryio/apiary-client.png?branch=master"></a></p>
|
69
71
|
|
70
|
-
<
|
71
|
-
official gem from Apiary at <a href="https://rubygems.org/gems/apiaryio">https://rubygems.org/gems/apiaryio</a></p>
|
72
|
+
<h2 id="label-Install">Install</h2>
|
72
73
|
|
73
|
-
<
|
74
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_apiaryio'>apiaryio</span></code></pre>
|
74
75
|
|
75
|
-
<
|
76
|
-
|
77
|
-
<h2>Description</h2>
|
76
|
+
<h2 id="label-Description">Description</h2>
|
78
77
|
|
79
78
|
<p>Apiaryio gem provides a way to display your API documentation on your local
|
80
|
-
machine, either using static files or using a standalone web server
|
79
|
+
machine, either using static files or using a standalone web server…</p>
|
81
80
|
|
82
|
-
<h2>Usage</h2>
|
81
|
+
<h2 id="label-Usage">Usage</h2>
|
83
82
|
|
84
|
-
<pre class="code ruby"><code>$ apiary help
|
83
|
+
<pre class="code ruby"><code class="ruby">$ apiary help
|
85
84
|
|
86
85
|
Usage: apiary command [options]
|
87
|
-
Try
|
86
|
+
Try 'apiary help' for more information.
|
88
87
|
|
89
88
|
Currently available apiary commands are:
|
90
89
|
|
@@ -94,25 +93,41 @@ Currently available apiary commands are:
|
|
94
93
|
preview --api_host [HOST] Specify apiary host
|
95
94
|
preview --server Start standalone web server on port 8080
|
96
95
|
preview --server --port [PORT] Start standalone web server on specified port
|
96
|
+
publish --api-name [API_NAME] Publish apiary.apib on docs.API_NAME.apiary.io"
|
97
|
+
fetch --api-name [API_NAME] Fetch apiary.apib from API_NAME.apiary.io"
|
97
98
|
|
98
99
|
help Show help
|
99
100
|
|
100
|
-
version Show version
|
101
|
-
|
101
|
+
version Show version</code></pre>
|
102
|
+
|
103
|
+
<h2 id="label-Copyright">Copyright</h2>
|
102
104
|
|
103
|
-
<
|
105
|
+
<p>Copyright 2012-14 © Apiary Ltd.</p>
|
104
106
|
|
105
|
-
<
|
107
|
+
<h2 id="label-Contributors">Contributors</h2>
|
108
|
+
<ul><li>
|
109
|
+
<p>Jakub Nešetřil</p>
|
110
|
+
</li><li>
|
111
|
+
<p>James Charles Russell</p>
|
112
|
+
</li><li>
|
113
|
+
<p>Lukáš Linhart</p>
|
114
|
+
</li><li>
|
115
|
+
<p>Emili Parreño</p>
|
116
|
+
</li><li>
|
117
|
+
<p>Peter Grilli [Tu1ly]</p>
|
118
|
+
</li><li>
|
119
|
+
<p>Ladislav Prskavec</p>
|
120
|
+
</li></ul>
|
106
121
|
|
107
|
-
<h2>License</h2>
|
122
|
+
<h2 id="label-License">License</h2>
|
108
123
|
|
109
124
|
<p>Released under MIT license. See LICENSE file for further details.</p>
|
110
125
|
</div></div>
|
111
126
|
|
112
127
|
<div id="footer">
|
113
|
-
Generated on
|
128
|
+
Generated on Sat Jan 25 12:41:41 2014 by
|
114
129
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
115
|
-
0.8.
|
130
|
+
0.8.7.3 (ruby-2.1.0).
|
116
131
|
</div>
|
117
132
|
|
118
133
|
</body>
|
data/doc/file_list.html
CHANGED
@@ -15,6 +15,7 @@
|
|
15
15
|
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
16
|
|
17
17
|
|
18
|
+
<title>File List</title>
|
18
19
|
<base id="base_target" target="_parent" />
|
19
20
|
</head>
|
20
21
|
<body>
|
@@ -46,7 +47,7 @@
|
|
46
47
|
<ul id="full_list" class="file">
|
47
48
|
|
48
49
|
|
49
|
-
<li class="r1"><a href="index.html" title="README">README</a></li>
|
50
|
+
<li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
|
50
51
|
|
51
52
|
|
52
53
|
</ul>
|
data/doc/frames.html
CHANGED
@@ -4,18 +4,16 @@
|
|
4
4
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
5
|
<head>
|
6
6
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
7
|
-
<title>Documentation by YARD 0.8.
|
7
|
+
<title>Documentation by YARD 0.8.7.3</title>
|
8
8
|
</head>
|
9
9
|
<script type="text/javascript" charset="utf-8">
|
10
10
|
window.onload = function() {
|
11
|
-
var match = window.location.hash.match(/^#!(.+)/);
|
12
|
-
var name = 'index.html';
|
13
|
-
|
14
|
-
name = unescape(match[1]);
|
15
|
-
}
|
11
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
12
|
+
var name = match ? match[1] : 'index.html';
|
13
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
16
14
|
document.writeln('<frameset cols="20%,*">' +
|
17
15
|
'<frame name="list" src="class_list.html" />' +
|
18
|
-
'<frame name="main" src="' + name + '" />' +
|
16
|
+
'<frame name="main" src="' + escape(name) + '" />' +
|
19
17
|
'</frameset>');
|
20
18
|
}
|
21
19
|
</script>
|
data/doc/index.html
CHANGED
@@ -6,13 +6,13 @@
|
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.8.
|
9
|
+
— Documentation by YARD 0.8.7.3
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
18
|
hasFrames = window.top.frames.main ? true : false;
|
@@ -61,30 +61,29 @@
|
|
61
61
|
|
62
62
|
<iframe id="search_frame"></iframe>
|
63
63
|
|
64
|
-
<div id="content"><div id='filecontents'
|
64
|
+
<div id="content"><div id='filecontents'>
|
65
|
+
<h1 id="label-apiaryio">apiaryio</h1>
|
65
66
|
|
66
67
|
<p>Apiary.io CLI</p>
|
67
68
|
|
68
|
-
<
|
69
|
+
<p><a href="https://travis-ci.org/apiaryio/apiary-client"><img
|
70
|
+
src="https://travis-ci.org/apiaryio/apiary-client.png?branch=master"></a></p>
|
69
71
|
|
70
|
-
<
|
71
|
-
official gem from Apiary at <a href="https://rubygems.org/gems/apiaryio">https://rubygems.org/gems/apiaryio</a></p>
|
72
|
+
<h2 id="label-Install">Install</h2>
|
72
73
|
|
73
|
-
<
|
74
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_apiaryio'>apiaryio</span></code></pre>
|
74
75
|
|
75
|
-
<
|
76
|
-
|
77
|
-
<h2>Description</h2>
|
76
|
+
<h2 id="label-Description">Description</h2>
|
78
77
|
|
79
78
|
<p>Apiaryio gem provides a way to display your API documentation on your local
|
80
|
-
machine, either using static files or using a standalone web server
|
79
|
+
machine, either using static files or using a standalone web server…</p>
|
81
80
|
|
82
|
-
<h2>Usage</h2>
|
81
|
+
<h2 id="label-Usage">Usage</h2>
|
83
82
|
|
84
|
-
<pre class="code ruby"><code>$ apiary help
|
83
|
+
<pre class="code ruby"><code class="ruby">$ apiary help
|
85
84
|
|
86
85
|
Usage: apiary command [options]
|
87
|
-
Try
|
86
|
+
Try 'apiary help' for more information.
|
88
87
|
|
89
88
|
Currently available apiary commands are:
|
90
89
|
|
@@ -94,25 +93,41 @@ Currently available apiary commands are:
|
|
94
93
|
preview --api_host [HOST] Specify apiary host
|
95
94
|
preview --server Start standalone web server on port 8080
|
96
95
|
preview --server --port [PORT] Start standalone web server on specified port
|
96
|
+
publish --api-name [API_NAME] Publish apiary.apib on docs.API_NAME.apiary.io"
|
97
|
+
fetch --api-name [API_NAME] Fetch apiary.apib from API_NAME.apiary.io"
|
97
98
|
|
98
99
|
help Show help
|
99
100
|
|
100
|
-
version Show version
|
101
|
-
|
101
|
+
version Show version</code></pre>
|
102
|
+
|
103
|
+
<h2 id="label-Copyright">Copyright</h2>
|
102
104
|
|
103
|
-
<
|
105
|
+
<p>Copyright 2012-14 © Apiary Ltd.</p>
|
104
106
|
|
105
|
-
<
|
107
|
+
<h2 id="label-Contributors">Contributors</h2>
|
108
|
+
<ul><li>
|
109
|
+
<p>Jakub Nešetřil</p>
|
110
|
+
</li><li>
|
111
|
+
<p>James Charles Russell</p>
|
112
|
+
</li><li>
|
113
|
+
<p>Lukáš Linhart</p>
|
114
|
+
</li><li>
|
115
|
+
<p>Emili Parreño</p>
|
116
|
+
</li><li>
|
117
|
+
<p>Peter Grilli [Tu1ly]</p>
|
118
|
+
</li><li>
|
119
|
+
<p>Ladislav Prskavec</p>
|
120
|
+
</li></ul>
|
106
121
|
|
107
|
-
<h2>License</h2>
|
122
|
+
<h2 id="label-License">License</h2>
|
108
123
|
|
109
124
|
<p>Released under MIT license. See LICENSE file for further details.</p>
|
110
125
|
</div></div>
|
111
126
|
|
112
127
|
<div id="footer">
|
113
|
-
Generated on
|
128
|
+
Generated on Sat Jan 25 12:41:41 2014 by
|
114
129
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
115
|
-
0.8.
|
130
|
+
0.8.7.3 (ruby-2.1.0).
|
116
131
|
</div>
|
117
132
|
|
118
133
|
</body>
|