Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: pass cname to docs command #370

Merged
merged 1 commit into from
Jan 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .aegir.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/** @type {import('aegir').PartialOptions} */
export default {
docs: {
cname: 'helia.io'
}
}
2 changes: 1 addition & 1 deletion benchmarks/add-dir/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion benchmarks/gc/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/block-brokers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/car/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/dag-cbor/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down
2 changes: 1 addition & 1 deletion packages/dag-json/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down
4 changes: 2 additions & 2 deletions packages/helia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion packages/helia/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/interface/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,6 @@
"progress-events": "^1.0.0"
},
"devDependencies": {
"aegir": "^42.0.1"
"aegir": "^42.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/interop/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/ipns/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion packages/json/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down
2 changes: 1 addition & 1 deletion packages/mfs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/mfs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/mfs/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion packages/strings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/strings/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down
2 changes: 1 addition & 1 deletion packages/strings/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion packages/unixfs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/unixfs/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down