chore: pass cname to docs command

ipfs · Jan 8, 2024 · 77caa8e · 77caa8e
1 parent a0692f9
commit 77caa8e
Show file tree

Hide file tree

Showing 22 changed files with 28 additions and 22 deletions.
diff --git a/.aegir.js b/.aegir.js
@@ -0,0 +1,6 @@
+/** @type {import('aegir').PartialOptions} */
+export default {
+  docs: {
+    cname: 'helia.io'
+  }
+}
diff --git a/benchmarks/add-dir/package.json b/benchmarks/add-dir/package.json
@@ -17,7 +17,7 @@
     "@helia/unixfs": "^1.4.0",
     "@ipld/dag-pb": "^4.0.2",
     "@libp2p/websockets": "^8.0.9",
-    "aegir": "^42.0.0",
+    "aegir": "^42.1.0",
     "blockstore-fs": "^1.0.1",
     "datastore-level": "^10.0.1",
     "execa": "^8.0.1",

diff --git a/benchmarks/gc/package.json b/benchmarks/gc/package.json
@@ -11,7 +11,7 @@
   },
   "devDependencies": {
     "@ipld/dag-pb": "^4.0.6",
-    "aegir": "^42.0.0",
+    "aegir": "^42.1.0",
     "blockstore-fs": "^1.1.8",
     "datastore-level": "^10.1.5",
     "execa": "^8.0.1",

diff --git a/package.json b/package.json
@@ -41,7 +41,7 @@
     "docs:no-publish": "aegir docs --publish false"
   },
   "devDependencies": {
-    "aegir": "^42.0.0",
+    "aegir": "^42.1.0",
     "npm-run-all": "^4.1.5"
   },
   "type": "module",

diff --git a/packages/block-brokers/package.json b/packages/block-brokers/package.json
@@ -68,7 +68,7 @@
   "devDependencies": {
     "@libp2p/logger": "^4.0.1",
     "@types/sinon": "^17.0.2",
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "delay": "^6.0.0",
     "it-all": "^3.0.4",

diff --git a/packages/car/package.json b/packages/car/package.json
@@ -153,7 +153,7 @@
   },
   "devDependencies": {
     "@helia/unixfs": "^2.0.0",
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "interface-blockstore": "^5.2.9",
     "ipfs-unixfs-importer": "^15.2.3",

diff --git a/packages/dag-cbor/package.json b/packages/dag-cbor/package.json
@@ -147,7 +147,7 @@
     "progress-events": "^1.0.0"
   },
   "devDependencies": {
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "interface-blockstore": "^5.2.9"
   }

diff --git a/packages/dag-json/package.json b/packages/dag-json/package.json
@@ -146,7 +146,7 @@
     "progress-events": "^1.0.0"
   },
   "devDependencies": {
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "interface-blockstore": "^5.2.9"
   }

diff --git a/packages/helia/README.md b/packages/helia/README.md
@@ -11,13 +11,13 @@
 
 > An implementation of IPFS in JavaScript
 
-## About
+# About
 
 Exports a `createHelia` function that returns an object that implements the Helia API.
 
 Pass it to other modules like @helia/unixfs to make files available on the distributed web.
 
-### Example
+## Example
 
 ```typescript
 import { createHelia } from 'helia'

diff --git a/packages/helia/package.json b/packages/helia/package.json
@@ -99,7 +99,7 @@
     "@multiformats/mafmt": "^12.1.5",
     "@multiformats/multiaddr": "^12.1.7",
     "@types/sinon": "^17.0.2",
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "delay": "^6.0.0",
     "it-all": "^3.0.4"
   },

diff --git a/packages/interface/package.json b/packages/interface/package.json
@@ -79,6 +79,6 @@
     "progress-events": "^1.0.0"
   },
   "devDependencies": {
-    "aegir": "^42.0.1"
+    "aegir": "^42.1.0"
   }
 }
diff --git a/packages/interop/package.json b/packages/interop/package.json
@@ -72,7 +72,7 @@
     "@libp2p/peer-id-factory": "^4.0.3",
     "@libp2p/websockets": "^8.0.1",
     "@multiformats/sha3": "^3.0.0",
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "helia": "^3.0.0",
     "ipfs-core-types": "^0.14.1",
     "ipfs-unixfs-importer": "^15.2.3",

diff --git a/packages/ipns/package.json b/packages/ipns/package.json
@@ -181,7 +181,7 @@
   "devDependencies": {
     "@libp2p/peer-id-factory": "^4.0.3",
     "@types/dns-packet": "^5.6.4",
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "datastore-core": "^9.2.0",
     "sinon": "^17.0.1",
     "sinon-ts": "^2.0.0"

diff --git a/packages/json/package.json b/packages/json/package.json
@@ -145,7 +145,7 @@
     "progress-events": "^1.0.0"
   },
   "devDependencies": {
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "interface-blockstore": "^5.2.9"
   }

diff --git a/packages/mfs/README.md b/packages/mfs/README.md
@@ -17,7 +17,7 @@
 
 `@helia/mfs` is an implementation of a Mutable File System powered by Helia.
 
-See the interface for all available operations.
+See the [API docs](https://ipfs.github.io/helia/modules/_helia_mfs.html) for all available operations.
 
 ## Example
 

diff --git a/packages/mfs/package.json b/packages/mfs/package.json
@@ -151,7 +151,7 @@
   },
   "devDependencies": {
     "@ipld/dag-pb": "^4.0.7",
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "datastore-core": "^9.2.0",
     "delay": "^6.0.0",

diff --git a/packages/mfs/src/index.ts b/packages/mfs/src/index.ts
@@ -3,7 +3,7 @@
  *
  * `@helia/mfs` is an implementation of a {@link https://docs.ipfs.tech/concepts/file-systems/ Mutable File System} powered by {@link https://github.com/ipfs/helia Helia}.
  *
- * See the {@link MFS MFS interface} for all available operations.
+ * See the [API docs](https://ipfs.github.io/helia/modules/_helia_mfs.html) for all available operations.
  *
  * @example
  *

diff --git a/packages/strings/README.md b/packages/strings/README.md
@@ -17,7 +17,7 @@
 
 `@helia/strings` makes working with strings Helia simple & straightforward.
 
-See the Strings interface for all available operations.
+See the [API docs](https://ipfs.github.io/helia/modules/_helia_strings.html) for all available operations.
 
 ## Example
 

diff --git a/packages/strings/package.json b/packages/strings/package.json
@@ -148,7 +148,7 @@
     "uint8arrays": "^5.0.1"
   },
   "devDependencies": {
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "interface-blockstore": "^5.2.9"
   }

diff --git a/packages/strings/src/index.ts b/packages/strings/src/index.ts
@@ -3,7 +3,7 @@
  *
  * `@helia/strings` makes working with strings {@link https://github.com/ipfs/helia Helia} simple & straightforward.
  *
- * See the {@link Strings Strings interface} for all available operations.
+ * See the [API docs](https://ipfs.github.io/helia/modules/_helia_strings.html) for all available operations.
  *
  * @example
  *

diff --git a/packages/unixfs/package.json b/packages/unixfs/package.json
@@ -178,7 +178,7 @@
     "uint8arrays": "^5.0.1"
   },
   "devDependencies": {
-    "aegir": "^42.0.1",
+    "aegir": "^42.1.0",
     "blockstore-core": "^4.3.8",
     "delay": "^6.0.0",
     "interface-blockstore": "^5.2.9",

diff --git a/packages/unixfs/src/index.ts b/packages/unixfs/src/index.ts
@@ -3,7 +3,7 @@
  *
  * `@helia/unixfs` is an implementation of a {@link https://github.com/ipfs/specs/blob/main/UNIXFS.md UnixFS filesystem} compatible with {@link https://github.com/ipfs/helia Helia}.
  *
- * See the {@link UnixFS UnixFS interface} for all available operations.
+ * See the [API docs](https://ipfs.github.io/helia/modules/_helia_unixfs.html) for all available operations.
  *
  * @example Creating files and directories
  *