Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TylorS committed Feb 6, 2016
1 parent fe47e8a commit 304af54
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,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/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/util.js#L81-L87'><code>src/util.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/util.js#L81-L87'><code>src/util.js</code></a></p>
<p>Function used to create HREFs that are properly namespaced</p>

<h4>Parameters</h4>
Expand All @@ -113,7 +113,7 @@ <h4>Returns</h4>
<h2 id='createLocation' class='mt0'>
createLocation<span class='gray'>([location])</span>
</h2>
<p><a href='https://github.com/TylorS/cyclic-router/blob/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/util.js#L120-L125'><code>src/util.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/util.js#L120-L125'><code>src/util.js</code></a></p>
<p>Create a location object - particularly useful for server-side rendering</p>

<h4>Parameters</h4>
Expand Down Expand Up @@ -141,7 +141,7 @@ <h4>Returns</h4>
<h2 id='createRouter' class='mt0'>
createRouter<span class='gray'>(history$)</span>
</h2>
<p><a href='https://github.com/TylorS/cyclic-router/blob/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/createRouter.js#L11-L13'><code>src/createRouter.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/createRouter.js#L11-L13'><code>src/createRouter.js</code></a></p>
<p>Creates a router instance from a history$</p>

<h4>Parameters</h4>
Expand All @@ -166,7 +166,7 @@ <h4>Returns</h4>
<h2 id='define' class='mt0'>
define<span class='gray'>(definitions)</span>
</h2>
<p><a href='https://github.com/TylorS/cyclic-router/blob/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/definitionResolver.js#L58-L103'><code>src/definitionResolver.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/definitionResolver.js#L58-L103'><code>src/definitionResolver.js</code></a></p>
<p>Function used to match the current route to a set of routes using
switch-path</p>

Expand All @@ -191,7 +191,7 @@ <h4>Returns</h4>
<h2 id='defineAPI' class='mt0'>
defineAPI<span class='gray'></span>
</h2>
<p><a href='https://github.com/TylorS/cyclic-router/blob/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/definitionResolver.js#L95-L101'><code>src/definitionResolver.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/definitionResolver.js#L95-L101'><code>src/definitionResolver.js</code></a></p>
<p>Propeties and methods returned from define()</p>

<h4>Properties</h4>
Expand Down Expand Up @@ -233,7 +233,7 @@ <h4>Properties</h4>
<h2 id='location' class='mt0'>
location<span class='gray'></span>
</h2>
<p><a href='https://github.com/TylorS/cyclic-router/blob/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/util.js#L103-L110'><code>src/util.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/util.js#L103-L110'><code>src/util.js</code></a></p>
<p>Default parameters for createLocation; Same structure used by rackt/history</p>

<h4>Properties</h4>
Expand Down Expand Up @@ -286,7 +286,7 @@ <h4>Properties</h4>
<h2 id='makeRouterDriver' class='mt0'>
makeRouterDriver<span class='gray'>(historyDriver)</span>
</h2>
<p><a href='https://github.com/TylorS/cyclic-router/blob/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/makeRouterDriver.js#L10-L27'><code>src/makeRouterDriver.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/makeRouterDriver.js#L10-L27'><code>src/makeRouterDriver.js</code></a></p>
<p>Factory function that returns the router driver</p>

<h4>Parameters</h4>
Expand All @@ -312,7 +312,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/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/pathFilter.js#L43-L49'><code>src/pathFilter.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/pathFilter.js#L43-L49'><code>src/pathFilter.js</code></a></p>
<p>Filters the current location to easily create nested routes</p>

<h4>Parameters</h4>
Expand All @@ -336,7 +336,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/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/api.js#L37-L43'><code>src/api.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/api.js#L37-L43'><code>src/api.js</code></a></p>
<p>The Public API returned by the router driver, createRouter(), and .path()</p>

<h4>Properties</h4>
Expand Down Expand Up @@ -386,7 +386,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/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/makeRouterDriver.js#L23-L26'><code>src/makeRouterDriver.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/makeRouterDriver.js#L23-L26'><code>src/makeRouterDriver.js</code></a></p>
<p>The actual router driver.</p>

<h4>Parameters</h4>
Expand All @@ -411,7 +411,7 @@ <h4>Returns</h4>
<h2 id='supportsHistory' class='mt0'>
supportsHistory<span class='gray'></span>
</h2>
<p><a href='https://github.com/TylorS/cyclic-router/blob/02ac4c0d06f2a5e8f346d80805e797e6a710d32a/src/util.js#L11-L28'><code>src/util.js</code></a></p>
<p><a href='https://github.com/TylorS/cyclic-router/blob/fe47e8a5b45d3b67f4031d0e8b892cb5d74bbb74/src/util.js#L11-L28'><code>src/util.js</code></a></p>
<p>Function that returns whether or not the current environment
supports the HistoryAPI</p>

Expand Down

0 comments on commit 304af54

Please sign in to comment.