Skip to content

Rebuild docs #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TylorS merged 5 commits into from
Mar 14, 2016
Merged

Rebuild docs #6

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d8e3c4c
chore(README): link to API docs
TylorS Feb 6, 2016
fe47e8a
Merge branch 'master' into gh-pages
TylorS Feb 6, 2016
304af54
rebuild docs
TylorS Feb 6, 2016
370e84e
Merge branch 'master' into gh-pages
TylorS Mar 14, 2016
5a540fa
chore(docs): build docs/
TylorS Mar 14, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 6 additions & 47 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@ <h3 class='mb0 no-anchor'></h3>
class='block bold'>
createHref
</a>
<a
href='#createRouter'
class='block bold'>
createRouter
</a>
<a
href='#define'
class='block bold'>
Expand Down Expand Up @@ -65,7 +60,7 @@ <h3 class='mb0 no-anchor'></h3>
<h2 id='createHref' class='mt0'>
createHref<span class='gray'>(path)</span>
</h2>
<p><a href='https://github.com/tylors/cyclic-router/blob/332912f0626e1e010ac11afd6c4fd1cff7da1712/src/util.js#L52-L58'><code>src/util.js</code></a></p>
<p><a href='https://github.com/tylors/cyclic-router/blob/370e84ecd691ab7dc02299163f74083e908800fb/src/util.js#L52-L58'><code>src/util.js</code></a></p>



Expand Down Expand Up @@ -95,47 +90,11 @@ <h4>Returns</h4>

</div>
</section>
</div><div class='py1'><section class='py2 clearfix'>
<h2 id='createRouter' class='mt0'>
createRouter<span class='gray'>(history$)</span>
</h2>
<p><a href='https://github.com/tylors/cyclic-router/blob/332912f0626e1e010ac11afd6c4fd1cff7da1712/src/createRouter.js#L12-L14'><code>src/createRouter.js</code></a></p>





<p>Creates a router instance from a history$. The history$ must have a
<code>.createHref</code> method attached to it</p>

<h4>Parameters</h4>
<ul class='suppress-p-margin'>
<li>Observable
.<
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Location">location</a>
>
<strong>history$</strong>
:
<div class='force-inline'>
<p>An observable of the
current location object as defined by rackt/history</p>

</div>
</li>
</ul>
<h4>Returns</h4>
<code>routerAPI
</code>

<div class='force-inline'>

</div>
</section>
</div><div class='py1'><section class='py2 clearfix'>
<h2 id='define' class='mt0'>
define<span class='gray'>(definitions)</span>
</h2>
<p><a href='https://github.com/tylors/cyclic-router/blob/332912f0626e1e010ac11afd6c4fd1cff7da1712/src/definitionResolver.js#L60-L74'><code>src/definitionResolver.js</code></a></p>
<p><a href='https://github.com/tylors/cyclic-router/blob/370e84ecd691ab7dc02299163f74083e908800fb/src/definitionResolver.js#L60-L74'><code>src/definitionResolver.js</code></a></p>



Expand Down Expand Up @@ -173,7 +132,7 @@ <h4>Returns</h4>
<h2 id='makeRouterDriver' class='mt0'>
makeRouterDriver<span class='gray'>(historyArgs)</span>
</h2>
<p><a href='https://github.com/tylors/cyclic-router/blob/332912f0626e1e010ac11afd6c4fd1cff7da1712/src/makeRouterDriver.js#L11-L27'><code>src/makeRouterDriver.js</code></a></p>
<p><a href='https://github.com/tylors/cyclic-router/blob/370e84ecd691ab7dc02299163f74083e908800fb/src/makeRouterDriver.js#L11-L27'><code>src/makeRouterDriver.js</code></a></p>



Expand Down Expand Up @@ -205,7 +164,7 @@ <h4>Returns</h4>
<h2 id='path' class='mt0'>
path<span class='gray'>(pathname)</span>
</h2>
<p><a href='https://github.com/tylors/cyclic-router/blob/332912f0626e1e010ac11afd6c4fd1cff7da1712/src/pathFilter.js#L43-L49'><code>src/pathFilter.js</code></a></p>
<p><a href='https://github.com/tylors/cyclic-router/blob/370e84ecd691ab7dc02299163f74083e908800fb/src/pathFilter.js#L43-L49'><code>src/pathFilter.js</code></a></p>



Expand Down Expand Up @@ -236,7 +195,7 @@ <h4>Returns</h4>
<h2 id='routerAPI' class='mt0'>
routerAPI<span class='gray'></span>
</h2>
<p><a href='https://github.com/tylors/cyclic-router/blob/332912f0626e1e010ac11afd6c4fd1cff7da1712/src/api.js#L37-L43'><code>src/api.js</code></a></p>
<p><a href='https://github.com/tylors/cyclic-router/blob/370e84ecd691ab7dc02299163f74083e908800fb/src/api.js#L37-L43'><code>src/api.js</code></a></p>



Expand Down Expand Up @@ -299,7 +258,7 @@ <h4>Properties</h4>
<h2 id='routerDriver' class='mt0'>
routerDriver<span class='gray'>(sink$)</span>
</h2>
<p><a href='https://github.com/tylors/cyclic-router/blob/332912f0626e1e010ac11afd6c4fd1cff7da1712/src/makeRouterDriver.js#L23-L26'><code>src/makeRouterDriver.js</code></a></p>
<p><a href='https://github.com/tylors/cyclic-router/blob/370e84ecd691ab7dc02299163f74083e908800fb/src/makeRouterDriver.js#L23-L26'><code>src/makeRouterDriver.js</code></a></p>



Expand Down