Skip to content

Commit 427b558

Browse files
committed
Refactor docs
1 parent 4bde1ec commit 427b558

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

readme.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ internals away.
7171
## Install
7272

7373
This package is [ESM only][esm].
74-
In Node.js (version 14.14+ and 16.0+), install with [npm][]:
74+
In Node.js (version 16+), install with [npm][]:
7575

7676
```sh
7777
npm install mdast-util-mdx-jsx
@@ -110,10 +110,10 @@ Say our document `example.mdx` contains:
110110
```js
111111
import fs from 'node:fs/promises'
112112
import * as acorn from 'acorn'
113-
import {fromMarkdown} from 'mdast-util-from-markdown'
114-
import {toMarkdown} from 'mdast-util-to-markdown'
115113
import {mdxJsx} from 'micromark-extension-mdx-jsx'
114+
import {fromMarkdown} from 'mdast-util-from-markdown'
116115
import {mdxJsxFromMarkdown, mdxJsxToMarkdown} from 'mdast-util-mdx-jsx'
116+
import {toMarkdown} from 'mdast-util-to-markdown'
117117

118118
const doc = await fs.readFile('example.mdx')
119119

@@ -424,7 +424,7 @@ The following interfaces are added to **[mdast][]** by this utility.
424424

425425
```idl
426426
interface MdxJsxFlowElement <: Parent {
427-
type: "mdxJsxFlowElement"
427+
type: 'mdxJsxFlowElement'
428428
}
429429
430430
MdxJsxFlowElement includes MdxJsxElement
@@ -457,7 +457,7 @@ Yields:
457457

458458
```idl
459459
interface MdxJsxTextElement <: Parent {
460-
type: "mdxJsxTextElement"
460+
type: 'mdxJsxTextElement'
461461
}
462462
463463
MdxJsxTextElement includes MdxJsxElement
@@ -497,17 +497,17 @@ interface mixin MdxJsxElement {
497497
}
498498
499499
interface MdxJsxExpressionAttribute <: Literal {
500-
type: "mdxJsxExpressionAttribute"
500+
type: 'mdxJsxExpressionAttribute'
501501
}
502502
503503
interface MdxJsxAttribute <: Node {
504-
type: "mdxJsxAttribute"
504+
type: 'mdxJsxAttribute'
505505
name: string
506506
value: MdxJsxAttributeValueExpression | string?
507507
}
508508
509509
interface MdxJsxAttributeValueExpression <: Literal {
510-
type: "mdxJsxAttributeValueExpression"
510+
type: 'mdxJsxAttributeValueExpression'
511511
}
512512
```
513513

@@ -577,12 +577,15 @@ visit(tree, function (node) {
577577

578578
## Compatibility
579579

580-
Projects maintained by the unified collective are compatible with all maintained
580+
Projects maintained by the unified collective are compatible with maintained
581581
versions of Node.js.
582-
As of now, that is Node.js 14.14+ and 16.0+.
583-
Our projects sometimes work with older versions, but this is not guaranteed.
584582

585-
This plugin works with `mdast-util-from-markdown` version 1+ and
583+
When we cut a new major release, we drop support for unmaintained versions of
584+
Node.
585+
This means we try to keep the current release line, `mdast-util-mdx-jsx@^2`,
586+
compatible with Node.js 12.
587+
588+
This utility works with `mdast-util-from-markdown` version 1+ and
586589
`mdast-util-to-markdown` version 1+.
587590

588591
## Related
@@ -620,9 +623,9 @@ abide by its terms.
620623

621624
[downloads]: https://www.npmjs.com/package/mdast-util-mdx-jsx
622625

623-
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-mdx-jsx.svg
626+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-mdx-jsx
624627

625-
[size]: https://bundlephobia.com/result?p=mdast-util-mdx-jsx
628+
[size]: https://bundlejs.com/?q=mdast-util-mdx-jsx
626629

627630
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
628631

0 commit comments

Comments
 (0)