Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

119 lines (79 sloc) 3.357 kB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
File: README
&mdash; Documentation by YARD 0.8.2.1
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> &raquo;
<span class="title">File: README</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><div id='filecontents'><h1>apiaryio</h1>
<p>Apiary.io CLI</p>
<h2>Disclaimer</h2>
<p>This gem is not the official apiaryio gem and is under development. You can find the
official gem from Apiary at <a href="https://rubygems.org/gems/apiaryio">https://rubygems.org/gems/apiaryio</a></p>
<h2>Requirements</h2>
<p>Ruby 1.9.x</p>
<h2>Description</h2>
<p>Apiaryio gem provides a way to display your API documentation on your local
machine, either using static files or using a standalone web server</p>
<h2>Usage</h2>
<pre class="code ruby"><code>$ apiary help
Usage: apiary command [options]
Try 'apiary help' for more information.
Currently available apiary commands are:
preview Show API documentation in default browser
preview --browser [chrome|safari|firefox] Show API documentation in specified browser
preview --path [PATH] Specify path to blueprint file
preview --api_host [HOST] Specify apiary host
preview --server Start standalone web server on port 8080
preview --server --port [PORT] Start standalone web server on specified port
help Show help
version Show version
</code></pre>
<h2>Copyright</h2>
<p>Copyright 2012 (c) Emili Parreño</p>
<h2>License</h2>
<p>Released under MIT license. See LICENSE file for further details.</p>
</div></div>
<div id="footer">
Generated on Tue Aug 7 17:58:18 2012 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.2.1 (ruby-1.9.2).
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.