Skip to content

Commit ef7d8af

Browse files
committed
Update readme.md
1 parent 6ec2b65 commit ef7d8af

File tree

1 file changed

+36
-18
lines changed

1 file changed

+36
-18
lines changed

readme.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# mdast-util-heading-style [![Build Status][travis-badge]][travis] [![Coverage Status][coverage-badge]][coverage]
1+
# mdast-util-heading-style [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
22

3-
Utility to get the style of an [**mdast**][mdast] heading.
3+
<!--lint disable list-item-spacing heading-increment list-item-indent-->
4+
5+
Get the style of an [**MDAST**][mdast] heading.
46

57
## Installation
68

7-
[npm][npm-install]:
9+
[npm][]:
810

911
```bash
1012
npm install mdast-util-heading-style
@@ -33,39 +35,55 @@ style(remark.parse('### ATX').children[0], 'setext'); // 'setext'
3335

3436
Get the heading style of a node.
3537

36-
**Parameters**:
37-
38-
* `node` ([`Node`][mdast-node]);
38+
###### Parameters
3939

40+
* `node` ([`Node`][node]) — Node to parse;
4041
* `relative` (`string`, optional) — Style to use for ambiguous headings
4142
(atx-headings with a level of three or more could also be setext).
4243

43-
**Returns**: `string` (`'atx'`, `'atx-closed'`, or `'setext'`)
44-
— When an ambiguous heading is found, either `relative` or `null` is
45-
returned.
44+
###### Returns
45+
46+
`string` (`'atx'`, `'atx-closed'`, or `'setext'`) — When an ambiguous
47+
heading is found, either `relative` or `null` is returned.
48+
49+
### `Marker`
50+
51+
A comment marker.
52+
53+
###### Properties
54+
55+
* `name` (`string`) — Name of marker;
56+
* `attributes` (`string`) — Value after name;
57+
* `parameters` (`Object`) — Parsed attributes, tries to convert
58+
values to numbers and booleans when possible;
59+
* `node` ([`Node`][node]) — Reference to given node.
4660

4761
## License
4862

49-
[MIT][license] © [Titus Wormer][home]
63+
[MIT][license] © [Titus Wormer][author]
5064

5165
<!-- Definitions -->
5266

53-
[travis-badge]: https://img.shields.io/travis/wooorm/mdast-util-heading-style.svg
67+
[build-badge]: https://img.shields.io/travis/wooorm/mdast-util-heading-style.svg
5468

55-
[travis]: https://travis-ci.org/wooorm/mdast-util-heading-style
69+
[build-status]: https://travis-ci.org/wooorm/mdast-util-heading-style
5670

5771
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/mdast-util-heading-style.svg
5872

59-
[coverage]: https://codecov.io/github/wooorm/mdast-util-heading-style
73+
[coverage-status]: https://codecov.io/github/wooorm/mdast-util-heading-style
6074

61-
[mdast]: https://github.com/wooorm/mdast
62-
63-
[mdast-node]: https://github.com/wooorm/mdast#node
75+
[chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg
6476

65-
[npm-install]: https://docs.npmjs.com/cli/install
77+
[chat]: https://gitter.im/wooorm/remark
6678

6779
[releases]: https://github.com/wooorm/mdast-util-heading-style/releases
6880

6981
[license]: LICENSE
7082

71-
[home]: http://wooorm.com
83+
[author]: http://wooorm.com
84+
85+
[npm]: https://docs.npmjs.com/cli/install
86+
87+
[mdast]: https://github.com/wooorm/mdast
88+
89+
[node]: https://github.com/wooorm/mdast#node

0 commit comments

Comments
 (0)