Skip to content

Commit 6fc0102

Browse files
committed
Refactor prose
1 parent c7859bf commit 6fc0102

File tree

1 file changed

+42
-14
lines changed

1 file changed

+42
-14
lines changed

readme.md

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
# hast-util-shift-heading [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Chat][chat-badge]][chat]
1+
# hast-util-shift-heading
22

3-
Change heading rank (or depth, level) in **[hast][]**.
3+
[![Build][build-badge]][build]
4+
[![Coverage][coverage-badge]][coverage]
5+
[![Downloads][downloads-badge]][downloads]
6+
[![Size][size-badge]][size]
7+
[![Sponsors][sponsors-badge]][collective]
8+
[![Backers][backers-badge]][collective]
9+
[![Chat][chat-badge]][chat]
410

5-
## Installation
11+
[**hast**][hast] utility to change the rank (depth, level) of headings.
12+
13+
## Install
614

715
[npm][]:
816

9-
```bash
17+
```sh
1018
npm install hast-util-shift-heading
1119
```
1220

1321
## Usage
1422

15-
```javascript
23+
```js
1624
var h = require('hastscript')
1725
var shift = require('hast-util-shift-heading')
1826

@@ -79,7 +87,7 @@ or `h7`).
7987

8088
###### Parameters
8189

82-
* `tree` ([`Node`][node]) — Tree to walk
90+
* `tree` ([`Node`][node]) — [*Tree*][tree] to walk
8391
* `shift` (`number`) — Non-null finite integer to use to shift ranks
8492

8593
###### Returns
@@ -92,11 +100,13 @@ or `h7`).
92100

93101
## Contribute
94102

95-
See [`contributing.md` in `syntax-tree/hast`][contributing] for ways to get
103+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
96104
started.
105+
See [`support.md`][support] for ways to get help.
97106

98-
This organisation has a [Code of Conduct][coc]. By interacting with this
99-
repository, organisation, or community you agree to abide by its terms.
107+
This project has a [Code of Conduct][coc].
108+
By interacting with this repository, organisation, or community you agree to
109+
abide by its terms.
100110

101111
## License
102112

@@ -112,20 +122,38 @@ repository, organisation, or community you agree to abide by its terms.
112122

113123
[coverage]: https://codecov.io/github/syntax-tree/hast-util-shift-heading
114124

125+
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-shift-heading.svg
126+
127+
[downloads]: https://www.npmjs.com/package/hast-util-shift-heading
128+
129+
[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-shift-heading.svg
130+
131+
[size]: https://bundlephobia.com/result?p=hast-util-shift-heading
132+
133+
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
134+
135+
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
136+
137+
[collective]: https://opencollective.com/unified
138+
115139
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
116140

117-
[chat]: https://spectrum.chat/unified/rehype
141+
[chat]: https://spectrum.chat/unified/syntax-tree
118142

119143
[npm]: https://docs.npmjs.com/cli/install
120144

121145
[license]: license
122146

123147
[author]: https://wooorm.com
124148

125-
[hast]: https://github.com/syntax-tree/hast
149+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
126150

127-
[node]: https://github.com/syntax-tree/unist#node
151+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
128152

129-
[contributing]: https://github.com/syntax-tree/hast/blob/master/contributing.md
153+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
154+
155+
[tree]: https://github.com/syntax-tree/unist#tree
156+
157+
[hast]: https://github.com/syntax-tree/hast
130158

131-
[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md
159+
[node]: https://github.com/syntax-tree/hast#nodes

0 commit comments

Comments
 (0)