@@ -13,22 +13,22 @@ footnotes, strikethrough, tables, tasklists).
13
13
14
14
## Contents
15
15
16
- * [ What is this?] ( #what-is-this )
17
- * [ When to use this] ( #when-to-use-this )
18
- * [ Install] ( #install )
19
- * [ Use] ( #use )
20
- * [ API] ( #api )
21
- * [ ` gfmFromMarkdown() ` ] ( #gfmfrommarkdown )
22
- * [ ` gfmToMarkdown(options?) ` ] ( #gfmtomarkdownoptions )
23
- * [ ` Options ` ] ( #options )
24
- * [ HTML] ( #html )
25
- * [ Syntax] ( #syntax )
26
- * [ Syntax tree] ( #syntax-tree )
27
- * [ Types] ( #types )
28
- * [ Compatibility] ( #compatibility )
29
- * [ Related] ( #related )
30
- * [ Contribute] ( #contribute )
31
- * [ License] ( #license )
16
+ * [ What is this?] ( #what-is-this )
17
+ * [ When to use this] ( #when-to-use-this )
18
+ * [ Install] ( #install )
19
+ * [ Use] ( #use )
20
+ * [ API] ( #api )
21
+ * [ ` gfmFromMarkdown() ` ] ( #gfmfrommarkdown )
22
+ * [ ` gfmToMarkdown(options?) ` ] ( #gfmtomarkdownoptions )
23
+ * [ ` Options ` ] ( #options )
24
+ * [ HTML] ( #html )
25
+ * [ Syntax] ( #syntax )
26
+ * [ Syntax tree] ( #syntax-tree )
27
+ * [ Types] ( #types )
28
+ * [ Compatibility] ( #compatibility )
29
+ * [ Related] ( #related )
30
+ * [ Contribute] ( #contribute )
31
+ * [ License] ( #license )
32
32
33
33
## What is this?
34
34
@@ -60,16 +60,16 @@ with [`micromark-extension-gfm`][extension].
60
60
61
61
Instead of this package, you can also use the extensions separately:
62
62
63
- * [ ` mdast-util-gfm-autolink-literal ` ] ( https://github.com/syntax-tree/mdast-util-gfm-autolink-literal )
64
- — support GFM autolink literals
65
- * [ ` mdast-util-gfm-footnote ` ] ( https://github.com/syntax-tree/mdast-util-gfm-footnote )
66
- — support GFM footnotes
67
- * [ ` mdast-util-gfm-strikethrough ` ] ( https://github.com/syntax-tree/mdast-util-gfm-strikethrough )
68
- — support GFM strikethrough
69
- * [ ` mdast-util-gfm-table ` ] ( https://github.com/syntax-tree/mdast-util-gfm-table )
70
- — support GFM tables
71
- * [ ` mdast-util-gfm-task-list-item ` ] ( https://github.com/syntax-tree/mdast-util-gfm-task-list-item )
72
- — support GFM tasklists
63
+ * [ ` mdast-util-gfm-autolink-literal ` ] ( https://github.com/syntax-tree/mdast-util-gfm-autolink-literal )
64
+ — support GFM autolink literals
65
+ * [ ` mdast-util-gfm-footnote ` ] ( https://github.com/syntax-tree/mdast-util-gfm-footnote )
66
+ — support GFM footnotes
67
+ * [ ` mdast-util-gfm-strikethrough ` ] ( https://github.com/syntax-tree/mdast-util-gfm-strikethrough )
68
+ — support GFM strikethrough
69
+ * [ ` mdast-util-gfm-table ` ] ( https://github.com/syntax-tree/mdast-util-gfm-table )
70
+ — support GFM tables
71
+ * [ ` mdast-util-gfm-task-list-item ` ] ( https://github.com/syntax-tree/mdast-util-gfm-task-list-item )
72
+ — support GFM tasklists
73
73
74
74
A different utility, [ ` mdast-util-frontmatter ` ] [ mdast-util-frontmatter ] , adds
75
75
support for frontmatter.
@@ -332,8 +332,8 @@ to enable GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
332
332
333
333
###### Parameters
334
334
335
- * ` options ` ([ ` Options ` ] [ api-options ] )
336
- — configuration
335
+ * ` options ` ([ ` Options ` ] [ api-options ] )
336
+ — configuration
337
337
338
338
###### Returns
339
339
@@ -346,13 +346,13 @@ Configuration (TypeScript type).
346
346
347
347
###### Fields
348
348
349
- * ` tableCellPadding ` (` boolean ` , default: ` true ` )
350
- — whether to add a space of padding between delimiters and cells
351
- * ` tablePipeAlign ` (` boolean ` , default: ` true ` )
352
- — whether to align the delimiters
353
- * ` stringLength ` (` ((value: string) => number) ` , default: ` s => s.length ` )
354
- — function to detect the length of table cell content, used when aligning
355
- the delimiters between cells
349
+ * ` tableCellPadding ` (` boolean ` , default: ` true ` )
350
+ — whether to add a space of padding between delimiters and cells
351
+ * ` tablePipeAlign ` (` boolean ` , default: ` true ` )
352
+ — whether to align the delimiters
353
+ * ` stringLength ` (` ((value: string) => number) ` , default: ` s => s.length ` )
354
+ — function to detect the length of table cell content, used when aligning
355
+ the delimiters between cells
356
356
357
357
## HTML
358
358
@@ -368,16 +368,16 @@ See [Syntax in `micromark-extension-gfm`][syntax].
368
368
This utility combines several mdast utilities.
369
369
See their readmes for the node types supported in the tree:
370
370
371
- * [ ` mdast-util-gfm-autolink-literal ` ] ( https://github.com/syntax-tree/mdast-util-gfm-autolink-literal#syntax-tree )
372
- — GFM autolink literals
373
- * [ ` mdast-util-gfm-footnote ` ] ( https://github.com/syntax-tree/mdast-util-gfm-footnote#syntax-tree )
374
- — GFM footnotes
375
- * [ ` mdast-util-gfm-strikethrough ` ] ( https://github.com/syntax-tree/mdast-util-gfm-strikethrough#syntax-tree )
376
- — GFM strikethrough
377
- * [ ` mdast-util-gfm-table ` ] ( https://github.com/syntax-tree/mdast-util-gfm-table#syntax-tree )
378
- — GFM tables
379
- * [ ` mdast-util-gfm-task-list-item ` ] ( https://github.com/syntax-tree/mdast-util-gfm-task-list-item#syntax-tree )
380
- — GFM tasklists
371
+ * [ ` mdast-util-gfm-autolink-literal ` ] ( https://github.com/syntax-tree/mdast-util-gfm-autolink-literal#syntax-tree )
372
+ — GFM autolink literals
373
+ * [ ` mdast-util-gfm-footnote ` ] ( https://github.com/syntax-tree/mdast-util-gfm-footnote#syntax-tree )
374
+ — GFM footnotes
375
+ * [ ` mdast-util-gfm-strikethrough ` ] ( https://github.com/syntax-tree/mdast-util-gfm-strikethrough#syntax-tree )
376
+ — GFM strikethrough
377
+ * [ ` mdast-util-gfm-table ` ] ( https://github.com/syntax-tree/mdast-util-gfm-table#syntax-tree )
378
+ — GFM tables
379
+ * [ ` mdast-util-gfm-task-list-item ` ] ( https://github.com/syntax-tree/mdast-util-gfm-task-list-item#syntax-tree )
380
+ — GFM tasklists
381
381
382
382
## Types
383
383
@@ -399,10 +399,10 @@ compatible with Node.js 16.
399
399
400
400
## Related
401
401
402
- * [ ` remark-gfm ` ] [ remark-gfm ]
403
- — remark plugin to support GFM
404
- * [ ` micromark-extension-gfm ` ] [ extension ]
405
- — micromark extension to parse GFM
402
+ * [ ` remark-gfm ` ] [ remark-gfm ]
403
+ — remark plugin to support GFM
404
+ * [ ` micromark-extension-gfm ` ] [ extension ]
405
+ — micromark extension to parse GFM
406
406
407
407
## Contribute
408
408
@@ -420,76 +420,76 @@ abide by its terms.
420
420
421
421
<!-- Definitions -->
422
422
423
- [ build-badge ] : https://github.com/syntax-tree/mdast-util-gfm/workflows/main/badge.svg
423
+ [ api-gfm-from-markdown ] : #gfmfrommarkdown
424
424
425
- [ build ] : https://github.com/syntax-tree/mdast-util-gfm/actions
425
+ [ api-gfm-to-markdown ] : #gfmtomarkdownoptions
426
426
427
- [ coverage-badge ] : https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm.svg
427
+ [ api-options ] : #options
428
428
429
- [ coverage ] : https://codecov.io/github/syntax-tree/mdast-util-gfm
429
+ [ author ] : https://wooorm.com
430
430
431
- [ downloads -badge] : https://img.shields.io/npm/dm/mdast-util-gfm .svg
431
+ [ backers -badge] : https://opencollective.com/unified/backers/badge .svg
432
432
433
- [ downloads ] : https://www.npmjs. com/package /mdast-util-gfm
433
+ [ build ] : https://github. com/syntax-tree /mdast-util-gfm/actions
434
434
435
- [ size -badge] : https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs. com/?q= mdast-util-gfm
435
+ [ build -badge] : https://github. com/syntax-tree/ mdast-util-gfm/workflows/main/badge.svg
436
436
437
- [ size ] : https://bundlejs .com/?q=mdast-util-gfm
437
+ [ chat ] : https://github .com/syntax-tree/unist/discussions
438
438
439
- [ sponsors -badge] : https://opencollective.com/unified/sponsors/ badge.svg
439
+ [ chat -badge] : https://img.shields.io/ badge/chat-discussions-success .svg
440
440
441
- [ backers-badge ] : https://opencollective .com/unified/backers/badge.svg
441
+ [ coc ] : https://github .com/syntax-tree/.github/blob/main/code-of-conduct.md
442
442
443
443
[ collective ] : https://opencollective.com/unified
444
444
445
- [ chat-badge ] : https://img.shields.io/badge/chat-discussions-success.svg
445
+ [ contributing ] : https://github.com/syntax-tree/.github/blob/main/contributing.md
446
446
447
- [ chat ] : https://github.com/ syntax-tree/unist/discussions
447
+ [ coverage ] : https://codecov.io/github/ syntax-tree/mdast-util-gfm
448
448
449
- [ npm ] : https://docs.npmjs.com/cli/install
449
+ [ coverage-badge ] : https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm.svg
450
+
451
+ [ downloads ] : https://www.npmjs.com/package/mdast-util-gfm
452
+
453
+ [ downloads-badge ] : https://img.shields.io/npm/dm/mdast-util-gfm.svg
450
454
451
455
[ esm ] : https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
452
456
453
457
[ esmsh ] : https://esm.sh
454
458
455
- [ typescript ] : https://www.typescriptlang.org
459
+ [ extension ] : https://github.com/micromark/micromark-extension-gfm
456
460
457
- [ license ] : license
461
+ [ from-markdown-extension ] : https://github.com/syntax-tree/mdast-util-from-markdown#extension
458
462
459
- [ author ] : https://wooorm. com
463
+ [ gfm ] : https://github.github. com/gfm/
460
464
461
465
[ health ] : https://github.com/syntax-tree/.github
462
466
463
- [ contributing ] : https://github.com/syntax-tree/.github/blob/main/contributing.md
464
-
465
- [ support ] : https://github.com/syntax-tree/.github/blob/main/support.md
466
-
467
- [ coc ] : https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
467
+ [ license ] : license
468
468
469
469
[ mdast ] : https://github.com/syntax-tree/mdast
470
470
471
- [ remark-gfm ] : https://github.com/remarkjs/remark-gfm
472
-
473
471
[ mdast-util-from-markdown ] : https://github.com/syntax-tree/mdast-util-from-markdown
474
472
475
- [ from-markdown-extension ] : https://github.com/syntax-tree/mdast-util-from-markdown#extension
473
+ [ mdast-util-frontmatter ] : https://github.com/syntax-tree/mdast-util-frontmatter
474
+
475
+ [ mdast-util-to-hast ] : https://github.com/syntax-tree/mdast-util-to-hast
476
476
477
477
[ mdast-util-to-markdown ] : https://github.com/syntax-tree/mdast-util-to-markdown
478
478
479
- [ to-markdown-extension ] : https://github. com/syntax-tree/mdast-util-to-markdown#options
479
+ [ npm ] : https://docs.npmjs. com/cli/install
480
480
481
- [ mdast-util-frontmatter ] : https://github.com/syntax-tree/mdast-util-frontmatter
481
+ [ remark-gfm ] : https://github.com/remarkjs/remark-gfm
482
482
483
- [ mdast-util-to-hast ] : https://github .com/syntax-tree/ mdast-util-to-hast
483
+ [ size ] : https://bundlejs .com/?q= mdast-util-gfm
484
484
485
- [ extension ] : https://github.com/micromark/micromark-extension -gfm
485
+ [ size-badge ] : https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util -gfm
486
486
487
- [ syntax ] : https://github .com/micromark/micromark-extension-gfm#syntax
487
+ [ sponsors-badge ] : https://opencollective .com/unified/sponsors/badge.svg
488
488
489
- [ gfm ] : https://github.github. com/gfm/
489
+ [ support ] : https://github.com/syntax-tree/.github/blob/main/support.md
490
490
491
- [ api-gfm-from-markdown ] : #gfmfrommarkdown
491
+ [ syntax ] : https://github.com/micromark/micromark-extension-gfm#syntax
492
492
493
- [ api-gfm- to-markdown] : #gfmtomarkdownoptions
493
+ [ to-markdown-extension ] : https://github.com/syntax-tree/mdast-util-to-markdown#options
494
494
495
- [ api-options ] : #options
495
+ [ typescript ] : https://www.typescriptlang.org
0 commit comments