1
- # mdast-util-phrasing [ ![ Build ] [ build-badge ]] [ build ] [ ![ Coverage ] [ coverage-badge ]] [ coverage ] [ ![ Downloads ] [ downloads-badge ]] [ downloads ] [ ![ Chat ] [ chat-badge ]] [ chat ]
1
+ # mdast-util-phrasing
2
2
3
- Check if a [ MDAST] [ ] (markdown) [ node] [ ] is a phrasing element.
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 ]
4
10
5
- ## Installation
11
+ Check if a [ mdast] [ ] [ node] [ ] is [ phrasing content] [ phrasing ] .
12
+
13
+ ## Install
6
14
7
15
[ npm] [ ] :
8
16
9
- ``` bash
17
+ ``` sh
10
18
npm install mdast-util-phrasing
11
19
```
12
20
13
21
## Usage
14
22
15
- ``` javascript
23
+ ``` js
16
24
var phrasing = require (' mdast-util-phrasing' )
17
25
18
26
phrasing ({
@@ -34,19 +42,21 @@ Check if the given value is a phrasing element.
34
42
35
43
###### Parameters
36
44
37
- ` node ` (` * ` ) — Value to check.
45
+ ` node ` (` * ` ) — Value to check, typically a [ node ] [ ] .
38
46
39
47
###### Returns
40
48
41
- ` boolean ` — whether ` node ` passes the test .
49
+ ` boolean ` — whether ` node ` is [ phrasing content ] [ phrasing ] .
42
50
43
51
## Contribute
44
52
45
- See [ ` contributing.md ` in ` syntax-tree/mdast ` ] [ contributing ] for ways to get
53
+ See [ ` contributing.md ` in ` syntax-tree/.github ` ] [ contributing ] for ways to get
46
54
started.
55
+ See [ ` support.md ` ] [ support ] for ways to get help.
47
56
48
- This organisation has a [ Code of Conduct] [ coc ] . By interacting with this
49
- repository, organisation, or community you agree to abide by its terms.
57
+ This project has a [ Code of Conduct] [ coc ] .
58
+ By interacting with this repository, organisation, or community you agree to
59
+ abide by its terms.
50
60
51
61
## License
52
62
@@ -66,20 +76,34 @@ repository, organisation, or community you agree to abide by its terms.
66
76
67
77
[ downloads ] : https://www.npmjs.com/package/mdast-util-phrasing
68
78
79
+ [ size-badge ] : https://img.shields.io/bundlephobia/minzip/mdast-util-phrasing.svg
80
+
81
+ [ size ] : https://bundlephobia.com/result?p=mdast-util-phrasing
82
+
83
+ [ sponsors-badge ] : https://opencollective.com/unified/sponsors/badge.svg
84
+
85
+ [ backers-badge ] : https://opencollective.com/unified/backers/badge.svg
86
+
87
+ [ collective ] : https://opencollective.com/unified
88
+
69
89
[ chat-badge ] : https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
70
90
71
- [ chat ] : https://spectrum.chat/unified/remark
91
+ [ chat ] : https://spectrum.chat/unified/syntax-tree
72
92
73
93
[ npm ] : https://docs.npmjs.com/cli/install
74
94
75
95
[ license ] : license
76
96
77
97
[ author ] : https://draft.li
78
98
79
- [ node ] : https://github.com/syntax-tree/mdast#ast
99
+ [ contributing ] : https://github.com/syntax-tree/.github/blob/master/contributing.md
100
+
101
+ [ support ] : https://github.com/syntax-tree/.github/blob/master/support.md
102
+
103
+ [ coc ] : https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
80
104
81
105
[ mdast ] : https://github.com/syntax-tree/mdast
82
106
83
- [ contributing ] : https://github.com/syntax-tree/mdast/blob/master/contributing.md
107
+ [ node ] : https://github.com/syntax-tree/mdast#nodes
84
108
85
- [ coc ] : https://github.com/syntax-tree/mdast/blob/master/code-of-conduct.md
109
+ [ phrasing ] : https://github.com/syntax-tree/mdast#phrasingcontent
0 commit comments