How to create a custom lint rule for Markdown and MDX using remark and ESLint

1. Gatsby

   1 372 55,906 8.4 JavaScript

   The best React-based framework with performance, scalability and security built in.

   

   In the last years, modern web development architectures based on client-side JavaScript, reusable APIs and prebuilt Markup (JAMstack), and new web frameworks (Gatsby, Gridsome or Next.js), have gained increased popularity amongst developers, and even allowed us to start using JSX within our Markdown (MDX).

2. SurveyJS

   surveyjs.io featured

   JavaScript Form Builder with No-Code UI & Built-In JSON Schema Editor. Keep full control over the data you collect and tailor the form builder’s entire look and feel to your users’ needs. SurveyJS works with React, Angular, Vue 3, and is compatible with any backend or auth system. Learn more.

   

3. mdx

   2 108 18,619 7.4 JavaScript

   Markdown for the component era

   

   In the last years, modern web development architectures based on client-side JavaScript, reusable APIs and prebuilt Markup (JAMstack), and new web frameworks (Gatsby, Gridsome or Next.js), have gained increased popularity amongst developers, and even allowed us to start using JSX within our Markdown (MDX).

4. Gridsome

   3 39 8,533 0.0 JavaScript

   ⚡️ The Jamstack framework for Vue.js

   

   In the last years, modern web development architectures based on client-side JavaScript, reusable APIs and prebuilt Markup (JAMstack), and new web frameworks (Gatsby, Gridsome or Next.js), have gained increased popularity amongst developers, and even allowed us to start using JSX within our Markdown (MDX).

5. Next.js

   4 2,361 133,243 10.0 JavaScript

   The React Framework

   

   In the last years, modern web development architectures based on client-side JavaScript, reusable APIs and prebuilt Markup (JAMstack), and new web frameworks (Gatsby, Gridsome or Next.js), have gained increased popularity amongst developers, and even allowed us to start using JSX within our Markdown (MDX).

6. blog-posts

   5 1 0 0.0 JavaScript

   

   Fork this repository with the complete tutorial, if you don't want to start from scratch.

7. remark-lint

   6 3 989 8.9 JavaScript

   plugins to check (lint) markdown code style

   

   With our dependencies all installed, we can start creating a .remarkrc.js, which will contain all the plugins that will be consumed by the remark processor. For details about alternative or advanced configurations, please refer to Configuring remark-lint.

8. remark

   7 47 8,322 7.7 JavaScript

   markdown processor powered by plugins part of the @unifiedjs collective (by remarkjs)

   

   remark-lint: a plugin to lint markdown built on remark: (a markdown processor).

9. Stream

   getstream.io featured

   Stream - Scalable APIs for Chat, Feeds, Moderation, & Video. Stream helps developers build engaging apps that scale to millions with performant and flexible Chat, Feeds, Moderation, and Video APIs and SDKs powered by a global edge network and enterprise-grade infrastructure.

   

10. mdast

    8 7 1,256 5.0

    Markdown Abstract Syntax Tree format

    

    Because we will be inspecting a mdast, which is a markdown abstract syntax tree built upon unist, we can take advantage of the many existing unist utilities to inspect our tree's nodes.

11. vfile

    9 1 508 6.8 JavaScript

    Virtual file format for text processing used in @unifiedjs

    

    file (required): a virtual file format.

12. unist

    10 3 936 5.0

    Universal Syntax Tree used by @unifiedjs

    

    Because we will be inspecting a mdast, which is a markdown abstract syntax tree built upon unist, we can take advantage of the many existing unist utilities to inspect our tree's nodes.

13. unist-util-visit

    11 2 299 4.3 JavaScript

    utility to visit nodes

    

    For this example, we will use unist-util-visit to recursively inspect all the image nodes, and unist-util-generated to ensure we are not inspecting nodes that we have generated ourselves and do not belong to the doc.md.

14. unist-util-generated

    12 1 4 5.5 JavaScript

    utility to check if a node is generated

    

    For this example, we will use unist-util-visit to recursively inspect all the image nodes, and unist-util-generated to ensure we are not inspecting nodes that we have generated ourselves and do not belong to the doc.md.

15. ESLint

    13 437 26,106 9.8 JavaScript

    Find and fix problems in your JavaScript code.

    

    ESLint: the most popular tool for linting JavaScript code.

16. eslint-mdx

    14 2 286 7.9 TypeScript

    ESLint Parser/Plugin for MDX

    

    ESLint MDX: an ESLint plugin/parser for MDX files.

17. InfluxDB

    www.influxdata.com featured

    InfluxDB – Built for High-Performance Time Series Workloads. InfluxDB 3 OSS is now GA. Transform, enrich, and act on time series data directly in the database. Automate critical tasks and eliminate the need to move data externally. Download now.

    

Suggest a related project