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

• Gatsby

  146 53,358 9.9 JavaScript

  Build blazing fast, modern apps and websites with React

  

  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).

• mdx

  48 13,593 8.7 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).

• Appwrite

  appwrite.io

  sponsored

  Appwrite - The Open Source Firebase alternative introduces iOS support . Appwrite is an open source backend server that helps you build native iOS applications much faster with realtime APIs for authentication, databases, files storage, cloud functions and much more!

  

• Gridsome

  14 8,287 6.2 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).

• Next.js

  797 90,888 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).

• blog-posts

  0 0 0.0 JavaScript

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

• remark-lint

  0 821 6.2 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.

• remark

  16 5,445 6.7 JavaScript

  remark is a popular tool that transforms markdown with plugins. These plugins can inspect and change your markup. You can use remark on the server, the client, CLIs, deno, etc. (by remarkjs)

  

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

• SonarLint

  www.sonarlint.org

  sponsored

  Clean code begins in your IDE with SonarLint. Up your coding game and discover issues early. SonarLint is a free plugin that helps you find & fix bugs and security issues from the moment you start writing code. Install from your favorite IDE marketplace today.

  

• mdast

  1 714 2.9

  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.

• vfile

  0 358 6.9 JavaScript

  Virtual file format for text processing used in @unifiedjs

  

  file (required): a virtual file format.

• unist

  0 614 3.1

  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.

• unist-util-visit

  0 153 4.5 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.

• unist-util-generated

  0 2 3.4 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.

• ESLint

  175 21,036 9.6 JavaScript

  Find and fix problems in your JavaScript code.

  

  ESLint: the most popular tool for linting JavaScript code.

• eslint-mdx

  1 138 8.4 TypeScript

  ESLint Parser/Plugin for MDX

  

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

Suggest a related project