27 lines
15 KiB
HTML
27 lines
15 KiB
HTML
|
<html><head><title>Flatworm Docs</title><link rel="stylesheet" type="text/css" href="/static/style.css"></head><body><div class="sidebar"><div class="header"><div class="logo"><a href="/"><div class="image"></div><div class="name">ethers.js</div><div class="version">v5.0</div></a></div></div><div class="toc"><div><div class="link title"><a href="/">Documentation</a></div><div class="base show link depth-1"><a href="/getting-started/">Getting Started</a></div><div class="hide link depth-2"><a href="/getting-started/#installing">Installing</a></div><div class="hide link depth-2"><a href="/getting-started/#importing">Importing</a></div><div class="base show link depth-1"><a href="/concepts/">Concepts</a></div><div class="hide link depth-2"><a href="/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/concepts/gas/">Gas</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-price">Gas Price</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-limit">Gas Limit</a></div><div class="base show link depth-1"><a href="/api/">Application Programming Interface</a></div><div class="hide link depth-2"><a href="/api/contract/">Contracts</a></div><div class="hide link depth-3"><a href="/api/contract/#buckets">Buckets</a></div><div class="hide link depth-2"><a href="/api/signer/">Signers</a></div><div class="hide link depth-3"><a href="/api/signer/#signer">Signer</a></div><div class="hide link depth-3"><a href="/api/signer/#wallet-inherits-signer">Wallet inherits Signer</a></div><div class="hide link depth-2"><a href="/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/api/providers/provider/">Provider</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#accounts-methods">Accounts Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#blocks-methods">Blocks Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#ethereum-naming-service-(ens)-methods">Ethereum Naming Service (ENS) Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#logs-methods">Logs Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#network-status-methods">Network Status Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#transactions-methods">Transactions Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#event-emitter-methods">Event Emitter Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#inspection-methods">Inspection Methods</a></div><div class="hide link depth-3"><a href="/api/providers/jsonrpc-provider/">JSON-RPC Provider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcprovider">JsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcsigner">JsonRpcSigner</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcuncheckedsigner">JsonRpcUncheckedSigner</a></div><div class="hide link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#nodesmithprovider">NodesmithProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div class="hide link depth-3"><a href="/api/providers/other/">Other Providers</a></div><div class="hide link depth-4"><a href="/api/providers/other/#fallbackprovider">FallbackProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#ipcprovider">IpcProvider</a></div><div class="hide link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-4"><a href="/api/providers/types/#blocks">Blocks</a></div><di
|
||
|
|
<a name="flatworm-docs"></a><h1>Flatworm Docs</h1>
|
||
|
|
<p>The <i>Flatworm Docs</i> rendering script is designed to be <b>very</b> simple, but provide enough formatting necessary for documenting JavaScript libraries.</p><p>A lot of its inspiration came from <a href="https://github.com/readthedocs/sphinx_rtd_theme">Read the Docs</a> and the <a href="https://www.sphinx-doc.org/">Sphinx</a> project.</p>
|
||
|
|
<a name="fragments"></a><h2>Fragments</h2>
|
||
|
|
<p>Flatworm Docs are made up of fragments. A fragment is either a lone body of <a href="/documentation/#flatworm-markdown">markdown</a> text, or a <a href="/documentation/#flatworm-directive">directive</a> for specialized formatting, which may itself have body.</p>
|
||
|
|
<a name="directive-format"></a><h3>Directive Format</h3>
|
||
|
|
|
||
|
|
<div class="code">_DIRECTIVE: VALUE @<LINK><br>BODY<br><br>DIRECTIVE: The directive name<br>VALUE: Optional; the value to pass to the directive<br>LINK: Optional; a name for internal linking<br>BODY: Optional; the directive body (certain directives only)</div>
|
||
|
|
|
||
|
|
<a name="flatworm-directive"></a><a name="flatworm-directives"></a><h3>Flatworm Directives</h3>
|
||
|
|
|
||
|
|
<div class="definition"><div class="term"><b>_section:</b> <i>TITLE</i></div><div class="body"><p>A <i>section</i> has its <b>TITLE</b> in an H1 font. Sections are linked to in <i>Table of Contents</i> and have a dividing line drawn above them. If an option is specified, it is avaialble as a name for intern linking. There should only be one <code class="inline">_section:</code> per page.</p></div></div>
|
||
|
|
<div class="definition"><div class="term"><b>_subsection:</b> <i>TITLE</i></div><div class="body"><p>A <i>subsection</i> has its <b>TITLE</b> in an H2 font. Subsections are linked to in <i>Table of Contents</i> and have a dividing line drawn above them. If an option is specified, it is avaialble as a name for internal linking.</p></div></div>
|
||
|
|
<div class="definition"><div class="term"><b>_heading:</b> <i>TITLE</i></div><div class="body"><p>A <i>heading</i> has its <b>TITLE</b> in an H3 font. If an option is specified, it is available as a name for internal linking.</p></div></div>
|
||
|
|
<div class="definition"><div class="term"><b>_definition:</b> <i>TERM</i></div><div class="body"><p>A <i>definition</i> has its <b>TERM</b> bolded and the markdown body is indented.</p></div></div>
|
||
|
|
<div class="definition"><div class="term"><b>_property:</b> <i>SIGNATURE</i></div><div class="body"><p>A <i>property</i> has its JavaScript <b>SIGNATURE</b> formatted and the markdown body is indented.</p></div></div>
|
||
|
|
<div class="definition"><div class="term"><b>_code:</b> <i>FILENAME</i></div><div class="body"><p>A <i>code</i> reads the <b>FILENAME</b> and depending on the extension adjusts it.</p><p>For JavaScript files, the file is executed, with <code class="inline">//!</code> replaced with the result of the last statement and <code class="inline">//!error</code> is replaced with the throw error. If the error state does not agree, rendering fails.</p></div></div>
|
||
|
|
<div class="definition"><div class="term"><b>_toc:</b></div><div class="body"><p>A <i>toc</i> injects a Table of Contents, loading each line of the body as a filename and recursively loads the <i>toc</i> if present, otherwise all the <i>sections</i> and <i>subsections</i>.</p></div></div>
|
||
|
|
<div class="definition"><div class="term"><b>_null:</b></div><div class="body"><p>A <i>null</i> is used to terminated a directive. For example, after a <i>definition</i>, the bodies are indented, so a <i>null</i> can be used to reset the indentation.</p></div></div>
|
||
|
|
<a name="examples"></a><h3>Examples</h3>
|
||
|
|
|
||
|
|
<div class="code">_section: Hello World @<link-to-this-section><br><br>_subsection: Some Example @<link-to-this-subsection><br><br>_heading: Large Bold Text @<link-to-this-heading><br><br>_definition: Flatworm<br>A phylum of relatively **simple** bilaterian, unsegmented,<br>soft-bodied invertebrates.<br><br>_property: String.fromCharCode(code) => string<br>Returns a string created from //code//, a sequence of<br>UTF-16 code units.<br><br>_code: filename.js<br><br>_toc:<br> some-file<br> some-directory<br><br>_null:<br>This breaks out of a directive. For example, to end a<br>_definition and reset the indentation.</div>
|
||
|
|
|
||
|
|
<a name="flatworm-markdown"></a><a name="markdown"></a><h2>Markdown</h2>
|
||
|
|
<p>The markdown is simple and does not have the flexibility of other dialects, but allows for <b>bold</b>, <i>italic</i>, <u>underlined</u>, <code class="inline">monospaced</code>, <sup>super-scripted</sup> text, supporting <a href="/documentation/#flatworm-markdown">links</a> and lists.</p>
|
||
|
|
<div class="code">**bold text**<br><br>//italic text//<br><br>__underlined text__<br><br>``monospace code``<br><br>^^superscript text^^<br><br>- This is a list<br>- With bullet points<br>- With a total of three items<br><br>This is separated by -- an en-dash.<br><br>This is separated by --- an em-dash.<br><br>This is a [Link to Ethereum](https://ethereum.org) and this<br>is an [Internal Link](some-link).<br><br>This is a self-titled link [[https://ethereumorg]] and this<br>[[some-link]] will use the title from its directives value.</div>
|
||
|
|
<div class="footer"><div class="nav previous"><a href="/contributing/"><span class="arrow">←</span>Contributing and Hacking</a></div> <div class="nav next"><a href="/license/">License and Copyright<span class="arrow">→</span></a></div></div><div class="copyright">The content of this site is licensed under the <a href="https://choosealicense.com/licenses/cc-by-4.0/">Creative Commons Attribution 4.0 International License</a>.</div></div><script src="/script.js" type="text/javascript"></script></body></html><!-- ContentHash:3255a6e6220db87df25958e1ffb7e1464c46181c33ffd7844b0fa732e8fa5174 -->
|