@@ -41,6 +41,14 @@ easier to transform content by abstracting these internals away.
41
41
If you want to handle syntax trees manually, use this.
42
42
For an easier time processing content, use the ** [ remark] [ ] ** ecosystem instead.
43
43
44
+ You can combine this utility with other utilities to add syntax extensions.
45
+ Notable examples that deeply integrate with it are
46
+ [ ` mdast-util-gfm ` ] [ mdast-util-gfm ] ,
47
+ [ ` mdast-util-mdx ` ] [ mdast-util-mdx ] ,
48
+ [ ` mdast-util-frontmatter ` ] [ mdast-util-frontmatter ] ,
49
+ [ ` mdast-util-math ` ] [ mdast-util-math ] , and
50
+ [ ` mdast-util-directive ` ] [ mdast-util-directive ] .
51
+
44
52
## Install
45
53
46
54
This package is [ ESM only] [ esm ] .
@@ -112,7 +120,7 @@ console.log(toMarkdown(tree))
112
120
113
121
## API
114
122
115
- This package exports the following identifier: ` toMarkdown ` .
123
+ This package exports the identifier ` toMarkdown ` .
116
124
There is no default export.
117
125
118
126
### ` toMarkdown(tree[, options]) `
@@ -346,9 +354,9 @@ The syntax tree is [mdast][].
346
354
## Types
347
355
348
356
This package is fully typed with [ TypeScript] [ ] .
349
- It exports the types ` Options ` , ` Map ` , ` Unsafe ` , ` Join ` , ` Handlers ` , ` Handle ` ,
350
- ` Context ` , ` SafeOptions ` , which model the interfaces used by options and
351
- extensions.
357
+ It exports the additional types ` Options ` , ` Map ` , ` Unsafe ` , ` Join ` , ` Handlers ` ,
358
+ ` Handle ` , ` Context ` , ` SafeOptions ` , which model the interfaces used by options
359
+ and extensions.
352
360
353
361
## Security
354
362
@@ -374,8 +382,8 @@ When parsing markdown afterwards and then going to HTML, use something like
374
382
375
383
## Contribute
376
384
377
- See [ ` contributing.md ` in ` syntax-tree/.github ` ] [ contributing ] for ways to get
378
- started.
385
+ See [ ` contributing.md ` ] [ contributing ] in [ ` syntax-tree/.github ` ] [ health ] for
386
+ ways to get started.
379
387
See [ ` support.md ` ] [ support ] for ways to get help.
380
388
381
389
This project has a [ code of conduct] [ coc ] .
@@ -422,22 +430,34 @@ abide by its terms.
422
430
423
431
[ author ] : https://wooorm.com
424
432
425
- [ contributing ] : https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
433
+ [ health ] : https://github.com/syntax-tree/.github
434
+
435
+ [ contributing ] : https://github.com/syntax-tree/.github/blob/main/contributing.md
426
436
427
- [ support ] : https://github.com/syntax-tree/.github/blob/HEAD /support.md
437
+ [ support ] : https://github.com/syntax-tree/.github/blob/main /support.md
428
438
429
- [ coc ] : https://github.com/syntax-tree/.github/blob/HEAD /code-of-conduct.md
439
+ [ coc ] : https://github.com/syntax-tree/.github/blob/main /code-of-conduct.md
430
440
431
441
[ esm ] : https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
432
442
433
443
[ typescript ] : https://www.typescriptlang.org
434
444
435
- [ mdast ] : https://github.com/syntax-tree/mdast
436
-
437
445
[ xss ] : https://en.wikipedia.org/wiki/Cross-site_scripting
438
446
439
447
[ hast-util-sanitize ] : https://github.com/syntax-tree/hast-util-sanitize
440
448
449
+ [ mdast ] : https://github.com/syntax-tree/mdast
450
+
451
+ [ mdast-util-gfm ] : https://github.com/syntax-tree/mdast-util-gfm
452
+
453
+ [ mdast-util-mdx ] : https://github.com/syntax-tree/mdast-util-mdx
454
+
455
+ [ mdast-util-frontmatter ] : https://github.com/syntax-tree/mdast-util-frontmatter
456
+
457
+ [ mdast-util-math ] : https://github.com/syntax-tree/mdast-util-math
458
+
459
+ [ mdast-util-directive ] : https://github.com/syntax-tree/mdast-util-directive
460
+
441
461
[ handlers ] : lib/handle
442
462
443
463
[ unsafe ] : lib/unsafe.js
0 commit comments