docs: publish api docs for all modules (libp2p#39)

Updates project config and publishes tsdocs for all child projects of this repo

Author: achingbrain

.gitignore

@@ -6,11 +6,11 @@
 
 build
 dist
-docs
+.docs
 
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 # Lock files
 package-lock.json
-yarn.lock
+yarn.lock

.npmrc

@@ -0,0 +1,2 @@
+; package-lock with tarball deps breaks lerna/nx - remove when https://github.com/semantic-release/github/pull/487 is merged
+package-lock=false

README.md

@@ -1,31 +1,35 @@
 # js-libp2p-peer-id <!-- omit in toc -->
 
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-peer-id.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-peer-id)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-peer-id/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-peer-id/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-peer-id/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > PeerId implementation and factory in JavaScript
 
 ## Table of contents <!-- omit in toc -->
 
 - [Structure](#structure)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribution](#contribution)
+- [Contribute](#contribute)
 
 ## Structure
 
 - [`/packages/libp2p-peer-id`](./packages/libp2p-peer-id) Implementation of @libp2p/interface-peer-id
 - [`/packages/libp2p-peer-id-factory`](./packages/libp2p-peer-id-factory) Create PeerId instances
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-peer-id>
+
 ## License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribution
+## Contribute
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

lerna.json

@@ -1,5 +1,5 @@
 {
-  "lerna": "4.0.0",
+  "lerna": "5.0.0",
   "useWorkspaces": true,
   "version": "independent",
   "command": {

package.json

@@ -34,10 +34,13 @@
     "generate": "lerna run generate",
     "build": "lerna run build",
     "lint": "lerna run lint",
+    "docs": "NODE_OPTIONS=--max_old_space_size=4096 aegir docs",
+    "docs:no-publish": "npm run docs -- --publish false",
     "dep-check": "lerna run dep-check",
-    "release": "lerna run --concurrency 1 release -- --"
+    "release": "npm run docs:no-publish && lerna run --concurrency 1 release && npm run docs"
   },
   "dependencies": {
+    "aegir": "^37.7.5",
     "lerna": "^5.0.0",
     "rimraf": "^3.0.2"
   },

packages/libp2p-peer-id-factory/README.md

@@ -1,27 +1,36 @@
 # @libp2p/peer-id-factory <!-- omit in toc -->
 
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-peer-id.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-peer-id)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-peer-id/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-peer-id/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-peer-id/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Create PeerId instances
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Description](#description)
 - [Example](#example)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribution](#contribution)
+- [Contribute](#contribute)
 
 ## Install
 
 ```console
 $ npm i @libp2p/peer-id-factory
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pPeerIdFactory` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/peer-id-factory/dist/index.min.js"></script>
+```
+
 ## Description
 
 Generate, import, and export PeerIDs, for use with [IPFS](https://github.com/ipfs/ipfs).
@@ -43,13 +52,17 @@ console.log(id.toString())
 12D3KooWRm8J3iL796zPFi2EtGGtUJn58AG67gcqzMFHZnnsTzqD
 ```
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-peer-id/modules/_libp2p_peer_id_factory.html>
+
 ## License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribution
+## Contribute
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

packages/libp2p-peer-id-factory/package.json

@@ -22,7 +22,7 @@
   "types": "./dist/src/index.d.ts",
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -152,8 +152,11 @@
     "uint8arrays": "^4.0.2"
   },
   "devDependencies": {
-    "aegir": "^37.0.7",
+    "aegir": "^37.7.5",
     "protons": "^6.0.0",
     "util": "^0.12.4"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
   }
 }

packages/libp2p-peer-id/README.md

@@ -1,27 +1,36 @@
 # @libp2p/peer-id <!-- omit in toc -->
 
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-peer-id.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-peer-id)
-[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-peer-id/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-peer-id/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-peer-id/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Implementation of @libp2p/interface-peer-id
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Description](#description)
 - [Example](#example)
+- [API Docs](#api-docs)
 - [License](#license)
-- [Contribution](#contribution)
+- [Contribute](#contribute)
 
 ## Install
 
 ```console
 $ npm i @libp2p/peer-id
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Libp2pPeerId` in the global namespace.
+
+```html
+<script src="https://unpkg.com/@libp2p/peer-id/dist/index.min.js"></script>
+```
+
 ## Description
 
 A basic implementation of a peer id
@@ -36,13 +45,17 @@ const id = new PeerId(...)
 console.log(id.toCid())
 ```
 
+## API Docs
+
+- <https://libp2p.github.io/js-libp2p-peer-id/modules/_libp2p_peer_id.html>
+
 ## License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribution
+## Contribute
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

packages/libp2p-peer-id/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@libp2p/peer-id",
   "version": "1.1.17",
-  "description": "Implementation of @libp2p/interface-peer-d",
+  "description": "Implementation of @libp2p/interface-peer-id",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-peer-id/tree/master/packages/libp2p-peer-id#readme",
   "repository": {
@@ -22,7 +22,7 @@
   "types": "./dist/src/index.d.ts",
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -144,6 +144,9 @@
     "uint8arrays": "^4.0.2"
   },
   "devDependencies": {
-    "aegir": "^37.0.7"
+    "aegir": "^37.7.5"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
   }
 }