Skip to content

Commit 579f20e

Browse files
authored
Add Linters section to Getting Started
Closes GH-2670. Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com> Reviewed-by: Titus Wormer <tituswormer@gmail.com>
1 parent af23c2d commit 579f20e

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/docs/getting-started.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ See [§ Using MDX][use] when you’re all set up and ready to use MDX.
2929
* [Integrations](#integrations)
3030
* [Bundlers](#bundlers)
3131
* [Build systems](#build-systems)
32+
* [Linters](#linters)
3233
* [Compilers](#compilers)
3334
* [Site generators](#site-generators)
3435
* [JSX runtimes](#jsx-runtimes)
@@ -392,6 +393,17 @@ See also [¶ Rollup][bundler-rollup] which is used in Vite and see
392393
[¶ Vue][jsx-runtime-vue] if you’re using that,
393394
for more info.
394395

396+
### Linters
397+
398+
#### ESLint
399+
400+
You can lint your MDX code with [ESLint][] using [`eslint-mdx`][eslint-mdx].
401+
402+
#### mdxlint
403+
404+
You can lint your MDX code with [`remark-lint`][remark-lint] and other
405+
[remark plugins][] using [`mdxlint`][mdxlint].
406+
395407
### Compilers
396408

397409
#### Babel
@@ -878,6 +890,10 @@ MDX files can be imported in [Bun][] by using
878890

879891
[esbuild-target]: https://esbuild.github.io/api/#target
880892

893+
[eslint]: https://eslint.org
894+
895+
[eslint-mdx]: https://github.com/mdx-js/eslint-mdx
896+
881897
[gatsby]: https://www.gatsbyjs.com
882898

883899
[gatsby-plugin-mdx]: https://www.gatsbyjs.com/plugins/gatsby-plugin-mdx/
@@ -936,6 +952,8 @@ MDX files can be imported in [Bun][] by using
936952

937953
[mdxjs-rs]: https://github.com/wooorm/mdxjs-rs
938954

955+
[mdxlint]: https://github.com/remcohaszing/mdxlint
956+
939957
[next]: https://nextjs.org
940958

941959
[next-configuring-mdx]: https://nextjs.org/docs/pages/building-your-application/configuring/mdx
@@ -950,6 +968,10 @@ MDX files can be imported in [Bun][] by using
950968

951969
[parcel-transformer-mdx]: https://github.com/EasyWebApp/Parcel-transformer-MDX
952970

971+
[remark plugins]: https://github.com/remarkjs/remark/blob/main/doc/plugins.md
972+
973+
[remark-lint]: https://github.com/remarkjs/remark-lint
974+
953975
[rollup]: https://rollupjs.org
954976

955977
[site-generator-next]: #nextjs

0 commit comments

Comments
 (0)