textlint-plugin-mdx 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -0
- package/lib/index.js +52 -28848
- package/package.json +9 -9
- package/lib/mdxProcessor.js +0 -28847
- package/lib/parse.js +0 -28822
package/README.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# textlint-plugin-mdx
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/textlint-plugin-mdx?activeTab=versions)
|
|
4
|
+
[](https://www.npmjs.com/package/textlint-plugin-mdx)
|
|
5
|
+
[](https://github.com/textlint/textlint-plugin-mdx/blob/HEAD/LICENSE)
|
|
6
|
+
[](https://github.com/textlint/textlint-plugin-mdx/actions/workflows/ci.yaml)
|
|
7
|
+
|
|
3
8
|
[textlint](https://github.com/textlint/textlint) plugin to lint [MDX](https://mdxjs.com/)
|
|
4
9
|
|
|
5
10
|
## Installation
|
|
@@ -20,6 +25,9 @@ bun add textlint-plugin-mdx
|
|
|
20
25
|
|
|
21
26
|
## Usage
|
|
22
27
|
|
|
28
|
+
> [!CAUTION]
|
|
29
|
+
> If you have enabled the `.mdx` extension in [@textlint/textlint-plugin-markdown](https://www.npmjs.com/package/@textlint/textlint-plugin-markdown), please remove it.
|
|
30
|
+
|
|
23
31
|
```json
|
|
24
32
|
{
|
|
25
33
|
"plugins": {
|
|
@@ -33,6 +41,25 @@ bun add textlint-plugin-mdx
|
|
|
33
41
|
- `extensions`: `string[]`
|
|
34
42
|
- Additional file extensions for MDX
|
|
35
43
|
|
|
44
|
+
## Examples
|
|
45
|
+
|
|
46
|
+
### textlint-filter-rule-comments
|
|
47
|
+
|
|
48
|
+
Example of how to use [textlint-filter-rule-comments](https://www.npmjs.com/package/textlint-filter-rule-comments) is shown below. There is no need to use syntax such as `{/* <!-- textlint-disable --> */}`.
|
|
49
|
+
|
|
50
|
+
```mdx
|
|
51
|
+
This is error text.
|
|
52
|
+
|
|
53
|
+
{/* textlint-disable */}
|
|
54
|
+
|
|
55
|
+
This is ignored text by rule.
|
|
56
|
+
Disables all rules between comments
|
|
57
|
+
|
|
58
|
+
{/* textlint-enable */}
|
|
59
|
+
|
|
60
|
+
This is error text.
|
|
61
|
+
```
|
|
62
|
+
|
|
36
63
|
## Contributing
|
|
37
64
|
|
|
38
65
|
1. Fork it!
|
|
@@ -41,6 +68,10 @@ bun add textlint-plugin-mdx
|
|
|
41
68
|
4. Push to the branch: `git push origin my-new-feature`
|
|
42
69
|
5. Submit a pull request :D
|
|
43
70
|
|
|
71
|
+
## Maintainers
|
|
72
|
+
|
|
73
|
+
- [@3w36zj6](https://github.com/3w36zj6)
|
|
74
|
+
|
|
44
75
|
## License
|
|
45
76
|
|
|
46
77
|
[MIT License](LICENSE)
|