Updated flatworm docs output.

docs.wrm/README.md

@@ -0,0 +1,16 @@
+Documentation
+=============
+
+These docs are built using [Flatworm Docs](https://github.com/ricmoo/flatworm).
+
+The output is placed in [docs](../docs) and generates both HTML and Markdown
+files.
+
+
+Building
+--------
+
+```
+/home/ricmoo/ethers.js> npm run build-docs 
+```
+

docs.wrm/api/providers/provider.wrm

@@ -137,5 +137,5 @@ Returns the list of Listeners for //eventName//.
 _subsection: Inspection Methods
 
 _property: Provider.isProvider(object) => boolean
-Returns true if and only if object is a Provider.
+Returns true if and only if //object// is a Provider.
 

docs.wrm/config.json

@@ -0,0 +1,9 @@
+{
+  "title": "ethers",
+  "subtitle": "v5.0-beta",
+  "logo": "logo.svg",
+  "link": "https://docs-beta.ethers.io",
+  "markdown": {
+      "banner": "-----\n\nDocumentation: [html](https://docs-beta.ethers.io/)\n\n-----\n\n"
+  }
+}

docs.wrm/logo.svg

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 23.0.4, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 100 58" style="enable-background:new 0 0 100 58;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill-rule:evenodd;clip-rule:evenodd;fill:#FFFFFF;}
+</style>
+<path class="st0" d="M94.45,47.18c-42.62,5.57-73.04,12.26-73.49-15.2c0,0,0.93-10.64,13.98-11.31c0,0,0.44-9.45,10.41-10.52
+	c5.36-0.58,11.45,4.94,12.11,10.75c0,0,13.19-2.44,13.76,10.42c0.2,4.48-0.81,12.1-13.53,11.77c0,0-7.36-1-8.36-12.38
+	c-2.07,22.03,29.78,20.75,30.24,0.74c0.2-8.65-5.34-17.55-17.82-15.88C54.91-1.64,36.7-0.65,29.92,15.31
+	c-9.69,0-17.1,7.46-16.99,17.2C13.3,63.86,56.93,54.41,94.45,47.18z"/>
+</svg>

docs/README.md

@@ -1,9 +1,10 @@
 -----
 
-test
+Documentation: [html](https://docs-beta.ethers.io/)
 
 -----
 
+
 What is ethers?
 ===============
 
@@ -140,4 +141,4 @@ older versions of the library.
 
 
 -----
-**Content Hash:** 488687b8320fc7da1517bdf2b1ac582250593622aca6b0b3244f61fc14973e42
+**Content Hash:** 6abeb4fa3f15b3443d89a26a6b0320f602a12368bc5ebbfb14a6cce682836167

docs/api/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Application Programming Interface (API)
 =======================================
@@ -74,4 +80,4 @@ Here...
 
 
 -----
-**Content Hash:** 3b51f44082b56d5b7fd9be77c92e6871df8642a3307b24d478ee625dbe1d8585
+**Content Hash:** cbd0b8ac4ada4bfee211c0553ac53e171a6900127d874743a0dedf7fa30618f3

docs/api/contract/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 
 Contracts
@@ -14,4 +20,4 @@ Buckets
 
 
 -----
-**Content Hash:** c703f8cc79e5372fb818572209c72eaa54c68385c2021e6fc412594379d834e0
+**Content Hash:** 190c93691014eae64ffcb66549f127aa73f4645fc7a4b3a2be9ae00216c79cf6

docs/api/providers/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Providers
 =========
@@ -78,4 +84,4 @@ Provider Documentation
 
 
 -----
-**Content Hash:** 7c81bceed28adc2b3e892a999c49c14f0d63d29be28d44587c6c2bc63ecd0204
+**Content Hash:** b15d8a2febb07abbbd784242c47575fbbb097f24643997ce30625c2e88adb095

docs/api/providers/api-providers/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 API Providers
 =============
@@ -44,4 +50,4 @@ Tra la la...
 
 
 -----
-**Content Hash:** cc4a4f172bf2c52a4c2876b44408d293e57ff92b1607ece82192adada290b93a
+**Content Hash:** 9669eaaa1c2e9a31256fdd49e1b7f79550f064056b1bfd67a8cef6c7b5f8d473

docs/api/providers/jsonrpc-provider/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 JSON-RPC Provider
 =================
@@ -45,4 +51,4 @@ TODO... Explain
 
 
 -----
-**Content Hash:** 497729952599bd12a48198ea62e259c24bb3ec8de38d594f346695f34753a2c2
+**Content Hash:** 09091214806fa2270a7425521fd948901355db2ec3406597fb5e29141b40639b

docs/api/providers/other/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Other Providers
 ===============
@@ -48,4 +54,4 @@ Explain...
 
 
 -----
-**Content Hash:** 5718f5431014c04862ff69aa2ff77548301446272c4ad92724b443850c10a117
+**Content Hash:** c950a8710b679e9061aa834f8b0366614dcb031270627249acb412813bb5ca94

docs/api/providers/types/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Types
 =====
@@ -122,4 +128,4 @@ TODO
 
 
 -----
-**Content Hash:** 9b08b2e4c2db679ae2fc80deb4ce59ec288da11c40730d7e1a045a2538436b17
+**Content Hash:** f6d5ea85b1ddef3a5b5bc0745984620507c001cf7d898c7842e006ddcd2b056b

docs/api/signer/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Signers
 =======
@@ -63,4 +69,4 @@ TODO
 
 
 -----
-**Content Hash:** abb9583fce7bfb330648881c6855cebac07174afa724901ba883e2b33dcb0a07
+**Content Hash:** 08ec198fa4ab407a1bed0a705073d7f40a6c3969b8e922961939fd8e009ca1ed

docs/api/utils/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Utilities
 =========
@@ -43,4 +49,4 @@ are also quite useful for application developers.
 
 
 -----
-**Content Hash:** 2ad729e67eb1303dcd0749dafe8b681b0e71d5511e3921ffdb45b81b2561755a
+**Content Hash:** ae9deb0419f2da1644ae9588d27ecc475961b741fa9d7b27b2cf13ddf62d50b6

docs/api/utils/address/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Addresses
 =========
@@ -42,4 +48,4 @@ TODO
 
 
 -----
-**Content Hash:** 85968aa9edabc277425171a51527f26b845070f5e2cc44ea573bae6b06a8b952
+**Content Hash:** 0e138a3fe39efa87749ebc8290d153f705d26e547a38b7dce5f4d85603264d24

docs/api/utils/bignumber/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 BigNumber
 =========
@@ -104,42 +110,42 @@ Returns an instance of a **BigNumber** for *aBigNumberish*.
 ```javascript
 // From a decimal string...
 BigNumber.from("42")
-// { BigNumber: "42" }</span>
+// { BigNumber: "42" }
 
 // From a hexstring...
 BigNumber.from("0x2a")
-// { BigNumber: "42" }</span>
+// { BigNumber: "42" }
 
 // From a negative hexstring...
 BigNumber.from("-0x2a")
-// { BigNumber: "-42" }</span>
+// { BigNumber: "-42" }
 
 // From an Array (or Uint8Array)...
 BigNumber.from([ 42 ])
-// { BigNumber: "42" }</span>
+// { BigNumber: "42" }
 
 // From an existing BigNumber...
 let one1 = constants.One;
 let one2 = BigNumber.from(one1)
 
 one2
-// { BigNumber: "1" }</span>
+// { BigNumber: "1" }
 
 // ...which returns the same instance
 one1 === one2
-// true</span>
+// true
 
 // From a (safe) number...
 BigNumber.from(42)
-// { BigNumber: "42" }</span>
+// { BigNumber: "42" }
 
 // From a ES2015 BigInt... (only on platforms with BigInt support)
 BigNumber.from(42n)
-// { BigNumber: "42" }</span>
+// { BigNumber: "42" }
 
 // Numbers outside the safe range fail:
 BigNumber.from(Number.MAX_SAFE_INTEGER);
-// Error: overflow (fault="overflow", operation="BigNumber.from", value=9007199254740991, version=bignumber/5.0.0-beta.129)</span>
+// Error: overflow (fault="overflow", operation="BigNumber.from", value=9007199254740991, version=bignumber/5.0.0-beta.129)
 ```
 
 
@@ -331,7 +337,7 @@ let a = BigNumber.from(42);
 let b = BigNumber.from("91");
 
   a.mul(b);
-  // { BigNumber: "3822" }</span>
+  // { BigNumber: "3822" }
 ```
 
 
@@ -349,7 +355,7 @@ A few short notes on numbers...
 The first problem many encounter when dealing with Ethereum is
 the concept of numbers. Most common currencies are broken down
 with very little granularity. For example, there are only 100
-cents in a single dollar. However, there are 10*18* **wei** in a
+cents in a single dollar. However, there are 10^18 **wei** in a
 single **ether**.
 
 JavaScript uses [IEEE 754 double-precision binary floating point](https://en.wikipedia.org/wiki/Double-precision_floating-point_format)
@@ -364,7 +370,7 @@ To demonstrate how this may be an issue in your code, consider:
 
 ```javascript
 (Number.MAX_SAFE_INTEGER + 2 - 2) == (Number.MAX_SAFE_INTEGER)
-// false</span>
+// false
 ```
 
 
@@ -380,4 +386,4 @@ mathematical operations handled safely.
 
 
 -----
-**Content Hash:** 2bd4504f910c0e79b352ebb19083a36d6ee0ed263c279aa64a4921a28874c2e9
+**Content Hash:** 269c8464ff80c77316617cbfa4e9a195d742f829a23911fecf0bba16961f81ae

docs/api/utils/bytes/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Byte Manipulation
 =================
@@ -119,27 +125,27 @@ zeros. The result of this function can be of odd-length.
 ```javascript
 // Convert a hexstring to a Uint8Array
 arrayify("0x1234")
-// [ 18, 52 ]</span>
+// [ 18, 52 ]
 
 // Convert an Array to a hexstring
 hexlify([1, 2, 3, 4])
-// 0x01020304</span>
+// 0x01020304
 
 // Convert an Object to a hexstring
 hexlify({ length: 2, "0": 1, "1": 2 })
-// 0x0102</span>
+// 0x0102
 
 // Convert an Array to a hexstring
 hexlify([ 1 ])
-// 0x01</span>
+// 0x01
 
 // Convert a number to a stripped hex value
 hexValue(1)
-// 0x1</span>
+// 0x1
 
 // Convert an Array to a stripped hex value
 hexValue([ 1, 2 ])
-// 0x102</span>
+// 0x102
 ```
 
 
@@ -240,4 +246,4 @@ computed.
 
 
 -----
-**Content Hash:** 6c6608cb249ff3e352417e8c99e1965500c19a3ae9b33d0397d7f8b84e78e20b
+**Content Hash:** 1e52066c61f8794d858f02fb8164b146c9379968b0e0ab90efeb2fe16831599f

docs/api/utils/constants/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Constants
 =========
@@ -98,4 +104,4 @@ The BigNumber value representing the maximum `uint256` value.
 
 
 -----
-**Content Hash:** 36d1996cf9909e8654bc8eef0c760bf3022681482bc88ebc553c79f0b224c9af
+**Content Hash:** a781a8990aec282632e70ebc003a711adf5bc7773243aed727fc37a0934097f7

docs/api/utils/display-logic/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Display Logic and Input
 =======================
@@ -104,4 +110,4 @@ The equivalent to calling `parseUnits(value, "ether")`.
 
 
 -----
-**Content Hash:** a0fd257cd92fcf3ae0659a22281fe10e7b68d632443cdf65556445a34365fcf1
+**Content Hash:** 172c3345092afd2abb6a47dc225ae54c13c3ee3ce87868dd87e19656f4e6078d

docs/api/utils/fixednumber/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 FixedNumber
 ===========
@@ -161,4 +167,4 @@ Returns true if and only if *value* is a **FixedNumber**.
 
 
 -----
-**Content Hash:** ddffbdca7bc7b54726596bd79a88e5df5dc947ff48bd2f93d516bb5b084aa4db
+**Content Hash:** e58731f51c5fe088aa89a78c7649ec914dce2d65dac9c1de3c4b3a89c911b46b

docs/api/utils/hashing/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Hashing Algorithms
 ==================
@@ -131,4 +137,4 @@ according to their respective type in *arrayOfTypes*.
 
 
 -----
-**Content Hash:** d67fa58e91e9358b895d2c6dbb0ab2f6b1ce71b85c7c0d9bc1a93b4ae2eb4b23
+**Content Hash:** 65dd2158ef160da7be3291c8e7aac15df2de683869df9c31b8efdaa39551b3e4

docs/api/utils/strings/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Strings
 =======
@@ -148,4 +154,4 @@ it should not be considered a method to acheive *any* level of security from
 
 
 -----
-**Content Hash:** f6a51816edca0ae4b74c16012629f26108f16204ff9d3aa3879fd44adb8d0d7f
+**Content Hash:** 74002cd3d9368872b5618f68967deac34a4d1aeafeeac6ddb5c1d06a450180c9

docs/concepts/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Concepts
 ========
@@ -15,4 +21,4 @@ which developers can make use of or should be aware of.
 
 
 -----
-**Content Hash:** 1a99161696ee94f8320ce5b63367cfc1245dadb9dc5f52819e5a547b3f44c509
+**Content Hash:** ad59f45600332d936821db1fa0d0eeabdab5b4f252e1e815de525b4d1b9a9a7b

docs/concepts/events/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Events
 ======
@@ -8,4 +14,4 @@ Explain how topics and such work
 
 
 -----
-**Content Hash:** 1b85be44f478836054f7efb2aa093d82c399ddd636153815991b334dc1c1b4b3
+**Content Hash:** 4b045e823bf9863272ddb1c5a8460bc461de2ad262503dc27829b64b57344d46

docs/concepts/gas/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Gas
 ===
@@ -20,4 +26,4 @@ Gas Limit
 
 
 -----
-**Content Hash:** 0e5b9d2e12fbc359899548a8f3d7a0951ee96cc3dec2b4b64be0e4dbfa1371eb
+**Content Hash:** 4cc3001196d861faac19ebc393e002ce9e6f24702b66bac62ef8f9185625b3dc

docs/contributing/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Contributing and Hacking
 ========================
@@ -36,4 +42,4 @@ use npm run update-version
 
 
 -----
-**Content Hash:** a9c6c700043f9b18ddd10b4b914603231c63c6adb95e26d3630fb39709b35eb6
+**Content Hash:** f817d13fd530f58e6a03c9b5cb7190a3b7a084e8bf6eb05b130665c36d421950

docs/cookbook/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Cookbook
 ========
@@ -8,4 +14,4 @@ Cooking...
 
 
 -----
-**Content Hash:** 19de63e3df2d64c5982c1625034ee40032aee1bd349eacf1cd8cf00c336548aa
+**Content Hash:** e3e2d42077858c887af142ae8f1c49a1882ea80d98cf4b75e272d97a65a0e713

docs/documentation/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Flatworm Docs
 =============
@@ -154,7 +160,7 @@ Markdown
 
 The markdown is simple and does not have the flexibility of
 other dialects, but allows for **bold**, *italic*,
-*underlined*, `monospaced`, *super-scripted* text,
+*underlined*, `monospaced`, ^super-scripted text,
 supporting [links](./) and lists.
 
 
@@ -188,4 +194,4 @@ This is a self-titled link [[https://ethereumorg]] and this
 
 
 -----
-**Content Hash:** 74aa879d77ec6a068c9233aefbf85188a6a18cacf24f5ba9c83cd3602c15e9ae
+**Content Hash:** 6cc55a98e7a50c76c8b27fbc7aae97bebaf9355a40b9c44a568f2f7fd927da57

docs/getting-started/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Getting Started
 ===============
@@ -60,4 +66,4 @@ Web Applications from our CDN.
 
 
 -----
-**Content Hash:** 5550edc55238e573fa55ca0421c610304a1c12cfa1281db2ddba44f36b1a3409
+**Content Hash:** 01b739e7d4410ec57652b8058ae7a5902107ce0b170ecd3550cbc97f4d287fd8

docs/license/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 License and Copyright
 =====================
@@ -34,4 +40,4 @@ SOFTWARE.
 
 
 -----
-**Content Hash:** 33d04a7c1199b1f7bee1b864f1610c01fde9a928993a6ffb5816b7268183e9d0
+**Content Hash:** 91addf1f9680c79e0db3ee454bc36cf3ba11b14221c075f21d8faf4d94146c65

docs/migration/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Migration Guide
 ===============
@@ -22,4 +28,4 @@ test
 
 
 -----
-**Content Hash:** 9b0d95b05f5e8941f7984f2f5141af4c4b17eef142c924bea54c446f11a367f4
+**Content Hash:** dc44071344e2a1a26a1638594b7403e8ab4722d4964a8ae5b9b94411eaa36f3c

docs/testing/README.md

@@ -1,3 +1,9 @@
+-----
+
+Documentation: [html](https://docs-beta.ethers.io/)
+
+-----
+
 
 Testing
 =======
@@ -8,4 +14,4 @@ Here goes info about testing
 
 
 -----
-**Content Hash:** 864815b384bd40e56f3a5aee328bde2186e7453d8a0e968d5e6a6c719096d725
+**Content Hash:** 8c2f2674db316066704a60c421caa69829c391dbf94998f98a603c75b237d42e