12
12
13
13
## Contents
14
14
15
- * [ What is this?] ( #what-is-this )
16
- * [ When should I use this?] ( #when-should-i-use-this )
17
- * [ Install] ( #install )
18
- * [ Use] ( #use )
19
- * [ API] ( #api )
20
- * [ ` zone(tree, name, handler) ` ] ( #zonetree-name-handler )
21
- * [ ` Handler ` ] ( #handler )
22
- * [ ` Info ` ] ( #info )
23
- * [ Types] ( #types )
24
- * [ Compatibility] ( #compatibility )
25
- * [ Security] ( #security )
26
- * [ Related] ( #related )
27
- * [ Contribute] ( #contribute )
28
- * [ License] ( #license )
15
+ * [ What is this?] ( #what-is-this )
16
+ * [ When should I use this?] ( #when-should-i-use-this )
17
+ * [ Install] ( #install )
18
+ * [ Use] ( #use )
19
+ * [ API] ( #api )
20
+ * [ ` zone(tree, name, handler) ` ] ( #zonetree-name-handler )
21
+ * [ ` Handler ` ] ( #handler )
22
+ * [ ` Info ` ] ( #info )
23
+ * [ Types] ( #types )
24
+ * [ Compatibility] ( #compatibility )
25
+ * [ Security] ( #security )
26
+ * [ Related] ( #related )
27
+ * [ Contribute] ( #contribute )
28
+ * [ License] ( #license )
29
29
30
30
## What is this?
31
31
@@ -128,12 +128,12 @@ Search `tree` for a start and end comments matching `name` and change their
128
128
129
129
###### Parameters
130
130
131
- * ` tree ` ([ ` Node ` ] [ node ] )
132
- — tree to change
133
- * ` name ` (` string ` )
134
- — comment name to look for
135
- * ` handler ` ([ ` Handler ` ] [ api-handler ] )
136
- — handle a section
131
+ * ` tree ` ([ ` Node ` ] [ node ] )
132
+ — tree to change
133
+ * ` name ` (` string ` )
134
+ — comment name to look for
135
+ * ` handler ` ([ ` Handler ` ] [ api-handler ] )
136
+ — handle a section
137
137
138
138
###### Returns
139
139
@@ -145,14 +145,14 @@ Callback called when a section is found (TypeScript type).
145
145
146
146
###### Parameters
147
147
148
- * ` start ` ([ ` Node ` ] [ node ] )
149
- — start of section
150
- * ` nodes ` ([ ` Array<Node> ` ] [ node ] )
151
- — nodes between ` start ` and ` end `
152
- * ` end ` ([ ` Node ` ] [ node ] )
153
- — end of section
154
- * ` info ` ([ ` Info ` ] [ api-info ] )
155
- — extra info
148
+ * ` start ` ([ ` Node ` ] [ node ] )
149
+ — start of section
150
+ * ` nodes ` ([ ` Array<Node> ` ] [ node ] )
151
+ — nodes between ` start ` and ` end `
152
+ * ` end ` ([ ` Node ` ] [ node ] )
153
+ — end of section
154
+ * ` info ` ([ ` Info ` ] [ api-info ] )
155
+ — extra info
156
156
157
157
###### Returns
158
158
@@ -168,12 +168,12 @@ Extra info (TypeScript type).
168
168
169
169
###### Fields
170
170
171
- * ` parent ` ([ ` Node ` ] [ node ] )
172
- — parent of the section
173
- * ` start ` (` number ` )
174
- — index of ` start ` in ` parent `
175
- * ` end ` (` number ` )
176
- — index of ` end ` in ` parent `
171
+ * ` parent ` ([ ` Node ` ] [ node ] )
172
+ — parent of the section
173
+ * ` start ` (` number ` )
174
+ — index of ` start ` in ` parent `
175
+ * ` end ` (` number ` )
176
+ — index of ` end ` in ` parent `
177
177
178
178
## Types
179
179
@@ -219,8 +219,8 @@ Either do not use user input or use [`hast-util-santize`][hast-util-sanitize].
219
219
220
220
## Related
221
221
222
- * [ ` mdast-util-heading-range ` ] ( https://github.com/syntax-tree/mdast-util-heading-range )
223
- — similar but uses headings to mark sections
222
+ * [ ` mdast-util-heading-range ` ] ( https://github.com/syntax-tree/mdast-util-heading-range )
223
+ — similar but uses headings to mark sections
224
224
225
225
## Contribute
226
226
0 commit comments