Skip to content

Commit

Permalink
chore: markdown lint
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Dec 1, 2023
1 parent 09209ae commit b8baf2f
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/styles/pln-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Arbol's
auditable
Audius
auspinner
autogenerated
BitSwap
bitswap
Blockchain
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/kubo/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ For issues and support, check out the [generate-cli-docs.sh](https://github.com/

IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like `ipfs swarm peers`, are only supported when online.

The [command-line quickstart guide](/how-to/command-line-quick-start/#take-your-node-online) explains how to start the IPFS daemon and take your node online.
The [command-line quickstart guide](../../how-to/command-line-quick-start.md) explains how to start the IPFS daemon and take your node online.



### Alignment with Kubo RPC API

Every command usable from the CLI is also available through the [RPC API v0](/reference/kubo/rpc). For example:
Every command usable from the CLI is also available through the [RPC API v0](../../reference/kubo/rpc.md). For example:

```sh
> ipfs swarm peers
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/kubo/generate-cli-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ For issues and support, check out the [generate-cli-docs.sh](https://github.com/
IPFS can run in either _online_ or _offline_ mode. Online mode is when you have IPFS running separately as a daemon process. If you do not have an IPFS daemon running, you are in offline mode. Some commands, like \`ipfs swarm peers\`, are only supported when online.
The [command-line quickstart guide](/how-to/command-line-quick-start/#take-your-node-online) explains how to start the IPFS daemon and take your node online.
The [command-line quickstart guide](../..//how-to/command-line-quick-start.md) explains how to start the IPFS daemon and take your node online.
"

echo "
### Alignment with Kubo RPC API
Every command usable from the CLI is also available through the [RPC API v0](/reference/kubo/rpc). For example:
Every command usable from the CLI is also available through the [RPC API v0](../../reference/kubo/rpc.md). For example:
\`\`\`sh
> ipfs swarm peers
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/kubo/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2313,7 +2313,7 @@ Resolve IPNS names.
- `recursive` [bool]: Resolve until the result is not an IPNS name. Default: `true`. Required: no.
- `nocache` [bool]: Do not use cached entries. Required: no.
- `dht-record-count` [uint]: Number of records to request for DHT resolution. Default: `16`. Required: no.
- `dht-timeout` [string]: Max time to collect values during DHT resolution eg "30s". Pass 0 for no timeout. Default: `1m0s`. Required: no.
- `dht-timeout` [string]: Max time to collect values during DHT resolution e.g. "30s". Pass 0 for no timeout. Default: `1m0s`. Required: no.
- `stream` [bool]: Stream entries as they are found. Required: no.


Expand Down

0 comments on commit b8baf2f

Please sign in to comment.