Skip to content
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

Set urls as html links #98

Merged
merged 1 commit into from
Feb 23, 2018
Merged

Set urls as html links #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You can also run `npm run webbuild` to build the library targeting the web. Note

### Running the dev server

Run `npm run dev` to run the dev server and serve the examples. The library source will be continuously recompiled. Examples will be available on http://localhost:8080. Don't forget to refresh the page after you change the source.
Run `npm run dev` to run the dev server and serve the examples. The library source will be continuously recompiled. Examples will be available on [http://localhost:8080](http://localhost:8080). Don't forget to refresh the page after you change the source.

### Running the tests

Expand All @@ -65,7 +65,7 @@ You may also provide mocha options through the `MOCHA_OPTS` environment variable

## Documentation

API documentation and tutorials can be found hosted online at https://gnosis.github.io/gnosis.js/
API documentation and tutorials can be found hosted online at [https://gnosis.github.io/gnosis.js/](https://gnosis.github.io/gnosis.js/)

### Running the docs

Expand Down
2 changes: 1 addition & 1 deletion docs/Gnosis.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5579,7 +5579,7 @@ <h5>Parameters:</h5>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/events.js.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h1 class="page-title">events.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ <h2>Development</h2><p>Before you begin, you will want to have the contracts dep
<pre class="prettyprint source"><code>npm run migrate</code></pre><p>The build process using Truffle will insert the chain locations in a <code>networks</code> key on the contract build artifacts.</p>
<h3>Building</h3><p>You can run <code>npm run nodebuild</code> to build the library for Node.js use.</p>
<p>You can also run <code>npm run webbuild</code> to build the library targeting the web. Note that this will compile in all network information present in the build artifacts, including temporary network information generated by Ganache-cli during migrations. You may use <code>npm run netreset</code> beforehand to remove unofficial network info and reset to official deployed locations if desired.</p>
<h3>Running the dev server</h3><p>Run <code>npm run dev</code> to run the dev server and serve the examples. The library source will be continuously recompiled. Examples will be available on http://localhost:8080. Don't forget to refresh the page after you change the source.</p>
<h3>Running the dev server</h3><p>Run <code>npm run dev</code> to run the dev server and serve the examples. The library source will be continuously recompiled. Examples will be available on <a href="http://localhost:8080">http://localhost:8080</a>. Don't forget to refresh the page after you change the source.</p>
<h3>Running the tests</h3><p>Run <code>npm test</code> to run test suite. This should run without the need of an RPC provider running on localhost:8545. If you already have such a provider running and wish to run the test suite without automatically spinning up Ganache-cli and causing a chain migration, use <code>npm run test-manual</code>.</p>
<p>You may also provide mocha options through the <code>MOCHA_OPTS</code> environment variable, e.g. <code>MOCHA_OPTS='-g estimate' npm test</code>.</p>
<h2>Documentation</h2><p>API documentation and tutorials can be found hosted online at https://gnosis.github.io/gnosis.js/</p>
<h2>Documentation</h2><p>API documentation and tutorials can be found hosted online at <a href="https://gnosis.github.io/gnosis.js/">https://gnosis.github.io/gnosis.js/</a></p>
<h3>Running the docs</h3><p>Run <code>npm run doc</code> to build and open a local build of the documentation in your browser.</p>
<h3>Web3 options</h3><p>The methods on the API can be provided with <code>from</code>, <code>to</code>, <code>value</code>, <code>gas</code>, and <code>gasPrice</code> options which get passed down to the <code>web3.js</code> layer.</p>
<h3>Gas estimations</h3><p>Many of the methods on the gnosis API also have an asynchronous <code>estimateGas</code> property which you can use, while allowing you to specify the gas estimation source. For example:</p>
Expand All @@ -99,7 +99,7 @@ <h3>Gas estimations</h3><p>Many of the methods on the gnosis API also have an as
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.js.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ <h1 class="page-title">index.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/lmsr.js.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ <h1 class="page-title">lmsr.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/markets.js.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ <h1 class="page-title">markets.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/oracles.js.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h1 class="page-title">oracles.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-api-overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h1 class="page-title">API Overview</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-developer-guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ <h1 class="page-title">Developer Guide</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-events-oracles-and-markets.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ <h3>Events and Collateral</h3><p>Once an oracle is created, an event contract ma
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-installation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h4>MetaMask</h4><p><a href="https://metamask.io/">MetaMask</a> is a Chrome brow
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-lmsr-primer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h3>LMSR Calculation Functions</h3><p>The functions <a href="Gnosis.html#.calcLM
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/utils.js.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ <h1 class="page-title">utils.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Feb 21 2018 21:58:08 GMT+0100 (CET) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Feb 23 2018 17:47:12 GMT+0100 (CET) using the Minami theme.
</footer>

<script>hljs.initHighlightingOnLoad();</script>
Expand Down