Skip to content

Commit 081ffce

Browse files
committed
Update docs
1 parent 9900fbe commit 081ffce

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
# MDX
22

3-
A Vale configuration for sites using [MDX][1]:
4-
5-
- [x] Adds support for using MDX comment syntax (`{/* ... */}`).
6-
- [x] Ignores `import`s and `export`s.
7-
- [x] Ignores `<Component ... />` and `<Component> ... </Component>`.
8-
- [x] Ignores `{ ... }`.
3+
A Vale configuration for sites using [MDX][1]. You'll want to following the
4+
[MDX installation][2] instructions before using this package.
95

106
## Getting Started
117

@@ -32,3 +28,4 @@ $ make test
3228
```
3329

3430
[1]: https://mdxjs.com
31+
[2]: https://vale.sh/docs/formats/mdx

0 commit comments

Comments
 (0)