1
- # mdast-comment-marker [ ![ Build ] [ build-badge ]] [ build ] [ ![ Coverage ] [ coverage-badge ]] [ coverage ] [ ![ Downloads ] [ downloads-badge ]] [ downloads ] [ ![ Chat ] [ chat-badge ]] [ chat ]
1
+ # mdast-comment-marker
2
2
3
- Parse [ mdast] [ ] comment markers.
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
+ [ ** mdast** ] [ mdast ] utility to parse comment markers.
12
+
13
+ ## Install
6
14
7
15
[ npm] [ ] :
8
16
9
- ``` bash
17
+ ``` sh
10
18
npm install mdast-comment-marker
11
19
```
12
20
13
21
## Usage
14
22
15
- ``` javascript
23
+ ``` js
16
24
var marker = require (' mdast-comment-marker' );
17
25
18
26
console .log (marker ({
@@ -65,7 +73,7 @@ Parse a comment marker.
65
73
66
74
###### Parameters
67
75
68
- * ` node ` ([ ` Node ` ] [ node ] ) — Node to parse
76
+ * ` node ` ([ ` Node ` ] [ node ] ) — [ Node] [ ] to parse
69
77
70
78
###### Returns
71
79
@@ -85,11 +93,13 @@ A comment marker.
85
93
86
94
## Contribute
87
95
88
- See [ ` contributing.md ` in ` syntax-tree/mdast ` ] [ contributing ] for ways to get
96
+ See [ ` contributing.md ` in ` syntax-tree/.github ` ] [ contributing ] for ways to get
89
97
started.
98
+ See [ ` support.md ` ] [ support ] for ways to get help.
90
99
91
- This organisation has a [ Code of Conduct] [ coc ] . By interacting with this
92
- repository, organisation, or community you agree to abide by its terms.
100
+ This project has a [ Code of Conduct] [ coc ] .
101
+ By interacting with this repository, organisation, or community you agree to
102
+ abide by its terms.
93
103
94
104
## License
95
105
@@ -109,22 +119,34 @@ repository, organisation, or community you agree to abide by its terms.
109
119
110
120
[ downloads ] : https://www.npmjs.com/package/mdast-comment-marker
111
121
122
+ [ size-badge ] : https://img.shields.io/bundlephobia/minzip/mdast-comment-marker.svg
123
+
124
+ [ size ] : https://bundlephobia.com/result?p=mdast-comment-marker
125
+
126
+ [ sponsors-badge ] : https://opencollective.com/unified/sponsors/badge.svg
127
+
128
+ [ backers-badge ] : https://opencollective.com/unified/backers/badge.svg
129
+
130
+ [ collective ] : https://opencollective.com/unified
131
+
112
132
[ chat-badge ] : https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
113
133
114
- [ chat ] : https://spectrum.chat/unified/remark
134
+ [ chat ] : https://spectrum.chat/unified/syntax-tree
135
+
136
+ [ npm ] : https://docs.npmjs.com/cli/install
115
137
116
138
[ license ] : license
117
139
118
140
[ author ] : https://wooorm.com
119
141
120
- [ npm ] : https://docs.npmjs.com/cli/install
142
+ [ contributing ] : https://github.com/syntax-tree/.github/blob/master/contributing.md
143
+
144
+ [ support ] : https://github.com/syntax-tree/.github/blob/master/support.md
145
+
146
+ [ coc ] : https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
121
147
122
148
[ mdast ] : https://github.com/syntax-tree/mdast
123
149
124
150
[ node ] : https://github.com/syntax-tree/unist#node
125
151
126
152
[ marker ] : #marker
127
-
128
- [ contributing ] : https://github.com/syntax-tree/mdast/blob/master/contributing.md
129
-
130
- [ coc ] : https://github.com/syntax-tree/mdast/blob/master/code-of-conduct.md
0 commit comments