Skip to content

Commit a13bb72

Browse files
committed
Refactor prose
1 parent 028aae0 commit a13bb72

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

readme.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@
88
[![Backers][backers-badge]][collective]
99
[![Chat][chat-badge]][chat]
1010

11-
[**Unist**][unist] utility to get the source of a [`Node`][node] or
12-
[`Position`][position].
11+
[**unist**][unist] utility to get the source of a node or at a position.
1312

14-
## Installation
13+
## Install
1514

1615
[npm][]:
1716

18-
```bash
17+
```sh
1918
npm install unist-util-source
2019
```
2120

@@ -59,19 +58,21 @@ Now, running `node example` yields:
5958
###### Parameters
6059

6160
* `value` ([`Node`][node] or [`Position`][position]) — Value to get
62-
* `doc` ([`VFile`][vfile] or `string`) — Document in which `value` exists
61+
* `doc` ([`VFile`][vfile] or `string`) — [file][] in which `value` exists
6362

6463
###### Returns
6564

66-
`string?` — Source of `value` in `file`, if available.
65+
`string?` — Source of `value` in `doc`, if available.
6766

6867
## Contribute
6968

70-
See [`contributing.md` in `syntax-tree/unist`][contributing] for ways to get
69+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
7170
started.
71+
See [`support.md`][support] for ways to get help.
7272

73-
This organisation has a [Code of Conduct][coc]. By interacting with this
74-
repository, organisation, or community you agree to abide by its terms.
73+
This project has a [Code of Conduct][coc].
74+
By interacting with this repository, organisation, or community you agree to
75+
abide by its terms.
7576

7677
## License
7778

@@ -111,6 +112,12 @@ repository, organisation, or community you agree to abide by its terms.
111112

112113
[author]: https://wooorm.com
113114

115+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
116+
117+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
118+
119+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
120+
114121
[unist]: https://github.com/syntax-tree/unist
115122

116123
[node]: https://github.com/syntax-tree/unist#node
@@ -119,6 +126,4 @@ repository, organisation, or community you agree to abide by its terms.
119126

120127
[vfile]: https://github.com/vfile/vfile
121128

122-
[contributing]: https://github.com/syntax-tree/unist/blob/master/contributing.md
123-
124-
[coc]: https://github.com/syntax-tree/unist/blob/master/code-of-conduct.md
129+
[file]: https://github.com/syntax-tree/unist#file

0 commit comments

Comments
 (0)