1212
1313## Contents
1414
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- * [ ` unified().use(remarkStringify[, options]) ` ] ( #unifieduseremarkstringify-options )
21- * [ Syntax] ( #syntax )
22- * [ Syntax tree] ( #syntax-tree )
23- * [ Types] ( #types )
24- * [ Security] ( #security )
25- * [ Contribute] ( #contribute )
26- * [ Sponsor] ( #sponsor )
27- * [ 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+ * [ ` unified().use(remarkStringify[, options]) ` ] ( #unifieduseremarkstringify-options )
21+ * [ ` Options ` ] ( #options )
22+ * [ Syntax] ( #syntax )
23+ * [ Syntax tree] ( #syntax-tree )
24+ * [ Types] ( #types )
25+ * [ Compatibility] ( #compatibility )
26+ * [ Security] ( #security )
27+ * [ Contribute] ( #contribute )
28+ * [ Sponsor] ( #sponsor )
29+ * [ License] ( #license )
2830
2931## What is this?
3032
@@ -125,8 +127,8 @@ Add support for serializing to markdown.
125127
126128###### Parameters
127129
128- * ` options ` ([ ` Options ` ] [ api-options ] , optional)
129- — configuration
130+ * ` options ` ([ ` Options ` ] [ api-options ] , optional)
131+ — configuration
130132
131133###### Returns
132134
@@ -138,60 +140,60 @@ Configuration (TypeScript type).
138140
139141###### Fields
140142
141- * ` bullet ` (` '*' ` , ` '+' ` , or ` '-' ` , default: ` '*' ` )
142- — marker to use for bullets of items in unordered lists
143- * ` bulletOther ` (` '*' ` , ` '+' ` , or ` '-' ` , default: ` '-' ` when ` bullet ` is
144- ` '*' ` , ` '*' ` otherwise)
145- — marker to use in certain cases where the primary bullet doesn’t work;
146- cannot be equal to ` bullet `
147- * ` bulletOrdered ` (` '.' ` or ` ')' ` , default: ` '.' ` )
148- — marker to use for bullets of items in ordered lists
149- * ` closeAtx ` (` boolean ` , default: ` false ` )
150- — add the same number of number signs (` # ` ) at the end of an ATX heading as
151- the opening sequence
152- * ` emphasis ` (` '*' ` or ` '_' ` , default: ` '*' ` )
153- — marker to use for emphasis
154- * ` fence ` (`` '`' `` or ` '~' ` , default: `` '`' `` )
155- — marker to use for fenced code
156- * ` fences ` (` boolean ` , default: ` true ` )
157- — use fenced code always; when ` false ` , uses fenced code if there is a
158- language defined, if the code is empty, or if it starts or ends in blank
159- lines
160- * ` handlers ` (` Handlers ` , optional)
161- — handle particular nodes;
162- see [ ` mdast-util-to-markdown ` ] [ mdast-util-to-markdown ] for more info
163- * ` incrementListMarker ` (` boolean ` , default: ` true ` )
164- — increment the counter of ordered lists items
165- * ` join ` (` Array<Join> ` , optional)
166- — how to join blocks;
167- see [ ` mdast-util-to-markdown ` ] [ mdast-util-to-markdown ] for more info
168- * ` listItemIndent ` (` 'mixed' ` , ` 'one' ` , or ` 'tab' ` , default: ` 'one' ` )
169- — how to indent the content of list items;
170- either with the size of the bullet plus one space (when ` 'one' ` ), a tab
171- stop (` 'tab' ` ), or depending on the item and its parent list: ` 'mixed' `
172- uses ` 'one' ` if the item and list are tight and ` 'tab' ` otherwise
173- * ` quote ` (` '"' ` or ` "'" ` , default: ` '"' ` )
174- — marker to use for titles
175- * ` resourceLink ` (` boolean ` , default: ` false ` )
176- — always use resource links (` [text](url) ` );
177- when ` false ` , uses autolinks (` <https://example.com> ` ) when possible
178- * ` rule ` (` '*' ` , ` '-' ` , or ` '_' ` , default: ` '*' ` )
179- — marker to use for thematic breaks
180- * ` ruleRepetition ` (` number ` , default: ` 3 ` , min: ` 3 ` )
181- — number of markers to use for thematic breaks
182- * ` ruleSpaces ` (` boolean ` , default: ` false ` )
183- — add spaces between markers in thematic breaks
184- * ` setext ` (` boolean ` , default: ` false ` )
185- — use setext headings when possible;
186- when ` true ` , uses setext headings (` heading\n======= ` ) for non-empty rank 1
187- or 2 headings
188- * ` strong ` (` '*' ` or ` '_' ` , default: ` '*' ` )
189- — marker to use for strong
190- * ` tightDefinitions ` (` boolean ` , default: ` false ` )
191- — join definitions without a blank line
192- * ` unsafe ` (` Array<Unsafe> ` , optional)
193- — schemas that define when characters cannot occur;
194- see [ ` mdast-util-to-markdown ` ] [ mdast-util-to-markdown ] for more info
143+ * ` bullet ` (` '*' ` , ` '+' ` , or ` '-' ` , default: ` '*' ` )
144+ — marker to use for bullets of items in unordered lists
145+ * ` bulletOther ` (` '*' ` , ` '+' ` , or ` '-' ` , default: ` '-' ` when ` bullet ` is
146+ ` '*' ` , ` '*' ` otherwise)
147+ — marker to use in certain cases where the primary bullet doesn’t work;
148+ cannot be equal to ` bullet `
149+ * ` bulletOrdered ` (` '.' ` or ` ')' ` , default: ` '.' ` )
150+ — marker to use for bullets of items in ordered lists
151+ * ` closeAtx ` (` boolean ` , default: ` false ` )
152+ — add the same number of number signs (` # ` ) at the end of an ATX heading as
153+ the opening sequence
154+ * ` emphasis ` (` '*' ` or ` '_' ` , default: ` '*' ` )
155+ — marker to use for emphasis
156+ * ` fence ` (`` '`' `` or ` '~' ` , default: `` '`' `` )
157+ — marker to use for fenced code
158+ * ` fences ` (` boolean ` , default: ` true ` )
159+ — use fenced code always; when ` false ` , uses fenced code if there is a
160+ language defined, if the code is empty, or if it starts or ends in blank
161+ lines
162+ * ` handlers ` (` Handlers ` , optional)
163+ — handle particular nodes;
164+ see [ ` mdast-util-to-markdown ` ] [ mdast-util-to-markdown ] for more info
165+ * ` incrementListMarker ` (` boolean ` , default: ` true ` )
166+ — increment the counter of ordered lists items
167+ * ` join ` (` Array<Join> ` , optional)
168+ — how to join blocks;
169+ see [ ` mdast-util-to-markdown ` ] [ mdast-util-to-markdown ] for more info
170+ * ` listItemIndent ` (` 'mixed' ` , ` 'one' ` , or ` 'tab' ` , default: ` 'one' ` )
171+ — how to indent the content of list items;
172+ either with the size of the bullet plus one space (when ` 'one' ` ), a tab
173+ stop (` 'tab' ` ), or depending on the item and its parent list: ` 'mixed' `
174+ uses ` 'one' ` if the item and list are tight and ` 'tab' ` otherwise
175+ * ` quote ` (` '"' ` or ` "'" ` , default: ` '"' ` )
176+ — marker to use for titles
177+ * ` resourceLink ` (` boolean ` , default: ` false ` )
178+ — always use resource links (` [text](url) ` );
179+ when ` false ` , uses autolinks (` <https://example.com> ` ) when possible
180+ * ` rule ` (` '*' ` , ` '-' ` , or ` '_' ` , default: ` '*' ` )
181+ — marker to use for thematic breaks
182+ * ` ruleRepetition ` (` number ` , default: ` 3 ` , min: ` 3 ` )
183+ — number of markers to use for thematic breaks
184+ * ` ruleSpaces ` (` boolean ` , default: ` false ` )
185+ — add spaces between markers in thematic breaks
186+ * ` setext ` (` boolean ` , default: ` false ` )
187+ — use setext headings when possible;
188+ when ` true ` , uses setext headings (` heading\n======= ` ) for non-empty rank 1
189+ or 2 headings
190+ * ` strong ` (` '*' ` or ` '_' ` , default: ` '*' ` )
191+ — marker to use for strong
192+ * ` tightDefinitions ` (` boolean ` , default: ` false ` )
193+ — join definitions without a blank line
194+ * ` unsafe ` (` Array<Unsafe> ` , optional)
195+ — schemas that define when characters cannot occur;
196+ see [ ` mdast-util-to-markdown ` ] [ mdast-util-to-markdown ] for more info
195197
196198<!-- Note: `extensions` intentionally not supported/documented. -->
197199
0 commit comments