Skip to content

Commit 0465152

Browse files
committed
Refactor prose
1 parent cf3e9f7 commit 0465152

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

readme.md

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

11+
[**mdast**][mdast] utility to make sure that there is only one top-level heading
12+
in the document by adjusting headings depths accordingly.
13+
1114
Providing multiple top-level headings per single markdown document is confusing
1215
for tools that assume that there is only a single top-level heading that
1316
contains some meta-information (usually title) about the document.
1417

15-
This [**mdast**][mdast] utility makes sure that there is only one top-level
16-
heading in the document by adjusting headings depths accordingly.
17-
18-
Originally extracted from [`remark-man`][man].
19-
20-
## Installation
18+
## Install
2119

2220
[npm][]:
2321

24-
```bash
22+
```sh
2523
npm install mdast-normalize-headings
2624
```
2725

@@ -63,7 +61,8 @@ Yields:
6361

6462
### `normalizeHeadings(tree)`
6563

66-
Modifies tree in-place. Returns `tree`.
64+
Modifies [tree][] in-place.
65+
Returns `tree`.
6766

6867
## Related
6968

@@ -72,11 +71,13 @@ Modifies tree in-place. Returns `tree`.
7271

7372
## Contribute
7473

75-
See [`contributing.md` in `syntax-tree/unist`][contributing] for ways to get
74+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
7675
started.
76+
See [`support.md`][support] for ways to get help.
7777

78-
This organisation has a [Code of Conduct][coc]. By interacting with this
79-
repository, organisation, or community you agree to abide by its terms.
78+
This project has a [Code of Conduct][coc].
79+
By interacting with this repository, organisation, or community you agree to
80+
abide by its terms.
8081

8182
## License
8283

@@ -114,14 +115,16 @@ repository, organisation, or community you agree to abide by its terms.
114115

115116
[license]: license
116117

117-
[contributing]: https://github.com/syntax-tree/unist/blob/master/contributing.md
118+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
118119

119-
[coc]: https://github.com/syntax-tree/unist/blob/master/code-of-conduct.md
120+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
121+
122+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
120123

121124
[mdast]: https://github.com/syntax-tree/mdast
122125

123126
[remark]: https://github.com/remarkjs/remark
124127

125-
[man]: https://github.com/remarkjs/remark-man
126-
127128
[normalize-headings]: https://github.com/remarkjs/remark-normalize-headings
129+
130+
[tree]: https://github.com/syntax-tree/unist#tree

0 commit comments

Comments
 (0)