quantus/common
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Swap docs to use vuepress (#330)

Browse Source 
* Play around, vuepress docs

* Cleanup old

* Build

* Round out updates
This commit is contained in:
Jaco Greeff
2019-02-26 11:14:20 +01:00
committed by GitHub
parent 4dc3494d4a
commit bc5edc4b42
38 changed files with 3631 additions and 8344 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/keyring/README.md
+5 -7
View File
@@ -17,7 +17,6 @@ Classes and Functions can be imported as follows:
```js
import Keyring from '@polkadot/keyring';
import pair from '@polkadot/keyring/pair';
import testKeyring from '@polkadot/keyring/testing';
```
@@ -26,10 +25,9 @@ Documentation and Available Utilities
Below is a list of currently exposed methods published at the [Polkadot-JS Common Documentation Portal](https://polkadot.js.org/common/keyring/).
* [keyring](https://polkadot.js.org/common/keyring/README.md)
* [keyring](README.md)
* Classes
* [Keyring](https://polkadot.js.org/common/keyring/classes/_index_.keyring.md)
* Functions
* [pair](https://polkadot.js.org/common/keyring/modules/_pair_index_.md)
* [testKeyring](https://polkadot.js.org/common/keyring/modules/_testing_.md)
* [Keyring](classes/_index_.keyring.md)
* Interfaces
* [pair](modules/_pair_index_.md)
* [testKeyring](modules/_testing_.md)
docs/keyring/index.html
-447
View File
@@ -1,447 +0,0 @@
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>keyring · Polkadot Common Book</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../gitbook/style.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-insert-logo-link/plugin.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
<link rel="stylesheet" href="../styles/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="../trie-db/" />
<link rel="prev" href="../" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Packages</li>
<li class="chapter " data-level="1.1" data-path="../">
<a href="../">
Introduction
</a>
</li>
<li class="chapter active" data-level="1.2" data-path="./">
<a href="./">
keyring
</a>
</li>
<li class="chapter " data-level="1.3" data-path="../trie-db/">
<a href="../trie-db/">
trie-db
</a>
</li>
<li class="chapter " data-level="1.4" data-path="../trie-hash/">
<a href="../trie-hash/">
trie-hash
</a>
</li>
<li class="chapter " data-level="1.5" data-path="../util/">
<a href="../util/">
util
</a>
</li>
<li class="chapter " data-level="1.6" data-path="../util-crypto/">
<a href="../util-crypto/">
util-crypto
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="2.1" data-path="../examples/keyring/">
<a href="../examples/keyring/">
Keyring
</a>
<ul class="articles">
<li class="chapter " data-level="2.1.1" data-path="../examples/keyring/01_create_account/">
<a href="../examples/keyring/01_create_account/">
Create Account
</a>
</li>
<li class="chapter " data-level="2.1.2" data-path="../examples/keyring/02_load_accounts/">
<a href="../examples/keyring/02_load_accounts/">
Load Accounts
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="2.2" data-path="../examples/util-crypto/">
<a href="../examples/util-crypto/">
Util-Crypto
</a>
<ul class="articles">
<li class="chapter " data-level="2.2.1" data-path="../examples/util-crypto/01_encrypt_decrypt_message_nacl/">
<a href="../examples/util-crypto/01_encrypt_decrypt_message_nacl/">
Encrypt & Decrypt Message
</a>
</li>
<li class="chapter " data-level="2.2.2" data-path="../examples/util-crypto/02_sign_verify_message_nacl/">
<a href="../examples/util-crypto/02_sign_verify_message_nacl/">
Sign & Verify Message
</a>
</li>
<li class="chapter " data-level="2.2.3" data-path="../examples/util-crypto/03_mnemonic_generate_validate_bip39/">
<a href="../examples/util-crypto/03_mnemonic_generate_validate_bip39/">
Create & Validate Mnemonic
</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href=".." >keyring</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="polkadotkeyring">@polkadot/keyring</h1>
<p>Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.</p>
<h2 id="usage">Usage</h2>
<p>Installation -</p>
<pre><code>yarn add @polkadot/keyring
</code></pre><p>Classes and Functions can be imported as follows:</p>
<pre><code class="lang-js"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Keyring</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/keyring&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">pair</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/keyring/pair&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">testKeyring</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/keyring/testing&apos;</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<h2 id="documentation-and-available-utilities">Documentation and Available Utilities</h2>
<p>Below is a list of currently exposed methods published at the <a href="https://polkadot.js.org/common/keyring/" target="_blank">Polkadot-JS Common Documentation Portal</a>.</p>
<ul>
<li><a href="https://polkadot.js.org/common/keyring/README.md" target="_blank">keyring</a><ul>
<li>Classes<ul>
<li><a href="https://polkadot.js.org/common/keyring/classes/_index_.keyring.md" target="_blank">Keyring</a></li>
</ul>
</li>
<li>Functions<ul>
<li><a href="https://polkadot.js.org/common/keyring/modules/_pair_index_.md" target="_blank">pair</a></li>
<li><a href="https://polkadot.js.org/common/keyring/modules/_testing_.md" target="_blank">testKeyring</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="../" class="navigation navigation-prev " aria-label="Previous page: Introduction">
<i class="fa fa-angle-left"></i>
</a>
<a href="../trie-db/" class="navigation navigation-next " aria-label="Next page: trie-db">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"keyring","level":"1.2","depth":1,"next":{"title":"trie-db","level":"1.3","depth":1,"path":"trie-db/README.md","ref":"trie-db/README.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/common/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot Common Book","gitbook":">=2.4.0"},"file":{"path":"keyring/README.md","mtime":"2019-02-25T16:08:25.142Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-25T16:09:42.846Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>
<script src="../gitbook/gitbook-plugin-insert-logo-link/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
<script src="../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>