Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit e381c8a

Browse files
authored
docs: fix examples links (#590)
The links to regular files api examples were broken. Also makes the 'importing from a url' and 'importing from the file system' headers linkable.
1 parent ddefb2e commit e381c8a

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

SPEC/FILES.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Prints out objects like:
156156

157157
Now [ipfs.io/ipfs/Qm...WW](https://ipfs.io/ipfs/QmNz1UBzpdd4HfZ3qir3aPiRdX5a93XwTuDNyXRc6PKhWW) returns the "ABC" string.
158158

159-
**Importing files from the file system:**
159+
###### Importing files from the file system
160160

161161
Both js-ipfs and js-ipfs-http-client export a utility to make importing files from the file system easier (Note: it not available in the browser).
162162

@@ -185,7 +185,7 @@ for await (const file of ipfs.add(globSource('./docs', { recursive: true }))) {
185185
*/
186186
```
187187

188-
**Importing a file from a URL:**
188+
###### Importing a file from a URL
189189

190190
Both js-ipfs and js-ipfs-http-client export a utility to make importing a file from a URL easier.
191191

@@ -208,7 +208,7 @@ for await (const file of ipfs.add(urlSource('https://ipfs.io/images/ipfs-logo.sv
208208
*/
209209
```
210210

211-
A great source of [examples][] can be found in the tests for this API.
211+
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/add.js) can be found in the tests for this API.
212212

213213
#### `cat`
214214

@@ -247,7 +247,7 @@ for await (const chunk of ipfs.cat(ipfsPath)) {
247247
console.log(Buffer.concat(chunks).toString())
248248
```
249249

250-
A great source of [examples][] can be found in the tests for this API.
250+
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/cat.js) can be found in the tests for this API.
251251

252252
#### `get`
253253

@@ -303,7 +303,7 @@ for await (const file of ipfs.get(cid)) {
303303
}
304304
```
305305

306-
A great source of [examples][] can be found in the tests for this API.
306+
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/get.js) can be found in the tests for this API.
307307

308308
#### `ls`
309309

@@ -353,7 +353,7 @@ for await (const file of ipfs.ls(cid)) {
353353
}
354354
```
355355

356-
A great source of [examples][] can be found in the tests for this API.
356+
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/ls.js) can be found in the tests for this API.
357357

358358
---
359359

@@ -769,7 +769,6 @@ for await (const file of ipfs.files.ls('/screenshots')) {
769769
// 2018-01-22T18:08:49.184Z.png
770770
```
771771

772-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/files-regular
773772
[b]: https://www.npmjs.com/package/buffer
774773
[file]: https://developer.mozilla.org/en-US/docs/Web/API/File
775774
[cid]: https://www.npmjs.com/package/cids

0 commit comments

Comments
 (0)