43 lines
7.2 KiB
HTML
43 lines
7.2 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>About | Nimbus Libraries</title>
|
|
<meta name="generator" content="VuePress 1.8.2">
|
|
<link rel="icon" href="/assets/img/logo.png">
|
|
<meta name="description" content="Ethereum 2.0 utilities and more">
|
|
|
|
<link rel="preload" href="/assets/css/0.styles.74783a08.css" as="style"><link rel="preload" href="/assets/js/app.b6b895fe.js" as="script"><link rel="preload" href="/assets/js/2.fd7e9e0b.js" as="script"><link rel="preload" href="/assets/js/8.b8ee59fd.js" as="script"><link rel="prefetch" href="/assets/js/10.a7e5f96d.js"><link rel="prefetch" href="/assets/js/11.b620ddcc.js"><link rel="prefetch" href="/assets/js/12.cf1bd068.js"><link rel="prefetch" href="/assets/js/13.9dfac9d9.js"><link rel="prefetch" href="/assets/js/14.1ce3f7fe.js"><link rel="prefetch" href="/assets/js/3.c5869ccf.js"><link rel="prefetch" href="/assets/js/4.b9b777bd.js"><link rel="prefetch" href="/assets/js/5.073c37d9.js"><link rel="prefetch" href="/assets/js/6.7db49fe2.js"><link rel="prefetch" href="/assets/js/7.852d0869.js"><link rel="prefetch" href="/assets/js/9.249d32d4.js">
|
|
<link rel="stylesheet" href="/assets/css/0.styles.74783a08.css">
|
|
</head>
|
|
<body>
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/" class="home-link router-link-active"><img src="/assets/img/logo.png" alt="Nimbus Libraries" class="logo"> <span class="site-name can-hide">Nimbus Libraries</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/lib/nim-libp2p/" class="nav-link">
|
|
libp2p
|
|
</a></div><div class="nav-item"><a href="/lib/nim-chronicles/" class="nav-link">
|
|
Chronicles
|
|
</a></div><div class="nav-item"><a href="/lib/nimcrypto/" class="nav-link">
|
|
Nimcrypto
|
|
</a></div><div class="nav-item"><a href="/lib/nim-chronos/" class="nav-link">
|
|
Chronos
|
|
</a></div><div class="nav-item"><a href="/lib/nim-eth/" class="nav-link">
|
|
Eth
|
|
</a></div><div class="nav-item"><a href="/lib/nim-stew/" class="nav-link">
|
|
Stew
|
|
</a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/lib/nim-libp2p/" class="nav-link">
|
|
libp2p
|
|
</a></div><div class="nav-item"><a href="/lib/nim-chronicles/" class="nav-link">
|
|
Chronicles
|
|
</a></div><div class="nav-item"><a href="/lib/nimcrypto/" class="nav-link">
|
|
Nimcrypto
|
|
</a></div><div class="nav-item"><a href="/lib/nim-chronos/" class="nav-link">
|
|
Chronos
|
|
</a></div><div class="nav-item"><a href="/lib/nim-eth/" class="nav-link">
|
|
Eth
|
|
</a></div><div class="nav-item"><a href="/lib/nim-stew/" class="nav-link">
|
|
Stew
|
|
</a></div> <!----></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>About</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/about.html#what-is-nimbus" class="sidebar-link">What is Nimbus?</a><ul class="sidebar-sub-headers"></ul></li><li><a href="/about.html#why-not-nimdoc" class="sidebar-link">Why not Nimdoc?</a><ul class="sidebar-sub-headers"></ul></li><li><a href="/about.html#contributing" class="sidebar-link">Contributing</a><ul class="sidebar-sub-headers"></ul></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="about"><a href="#about" class="header-anchor">#</a> About</h1> <p>This documentation suite was created as a comprehensive guide for using the Nim libraries produced by the Nimbus team at Status.im.</p> <h2 id="what-is-nimbus"><a href="#what-is-nimbus" class="header-anchor">#</a> What is Nimbus?</h2> <p><a href="https://nimbus.status.im" target="_blank" rel="noopener noreferrer">Nimbus<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> is an Ethereum 2.0 client, but these libraries are designed to be used outside of that context too. If your project needs good cryptography or verbose logging output, these libraries should fit the bill nicely.</p> <p>You do not need to be a Nimbus user or developer to make use of these libraries.</p> <h2 id="why-not-nimdoc"><a href="#why-not-nimdoc" class="header-anchor">#</a> Why not Nimdoc?</h2> <p>We actually do use Nimdoc for the API reference included in each library's documentation on this site. However, Nimdoc's template isn't the easiest to modify and it can produce some buggy results, so we use its JSON output to feed the API docs into this tome, and we use Vuepress for the rest of the functionality, like custom layouts, styling, SEO support, searchability, and of course - custom documentation support, like guides, tutorials, references, and more.</p> <h2 id="contributing"><a href="#contributing" class="header-anchor">#</a> Contributing</h2> <p>You can contribute to these docs by submitting issues or pull requests in the official repository at <a href="https://github.com/status-im/nimbus-libs-site" target="_blank" rel="noopener noreferrer">status-im/nimbus-libs-site<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>.</p> <p>Keep in mind the following:</p> <ul><li>the API reference is generated from individual libraries. Thus, if you notice a mistake in the API reference, to submit a fix you should submit a PR to the library in question and fix its docblock.</li> <li>the guides are curated and not everything that's written about the libraries will be included here.</li></ul></div> <footer class="page-edit"><!----> <!----></footer> <!----> </main></div><div class="global-ui"></div></div>
|
|
<script src="/assets/js/app.b6b895fe.js" defer></script><script src="/assets/js/2.fd7e9e0b.js" defer></script><script src="/assets/js/8.b8ee59fd.js" defer></script>
|
|
</body>
|
|
</html>
|