Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

remark-lint

Package Overview
Dependencies
Maintainers
3
Versions
40
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark-lint

remark plugin to lint Markdown code style

  • 10.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
199K
decreased by-0.66%
Maintainers
3
Weekly downloads
 
Created

What is remark-lint?

remark-lint is a plugin for remark, a Markdown processor powered by plugins. It provides a framework for analyzing and reporting on Markdown code quality issues, ensuring consistency and adherence to specified style guidelines.

What are remark-lint's main functionalities?

Linting Markdown Files

This feature allows you to lint Markdown files to ensure they adhere to specified style guidelines. The code sample demonstrates how to use remark-lint to process a simple Markdown string and report any issues.

const remark = require('remark');
const lint = require('remark-lint');

remark()
  .use(lint)
  .process('# Hello world!', function (err, file) {
    console.error(report(err || file));
  });

Custom Rules

remark-lint supports custom rules, allowing you to enforce specific style guidelines. The code sample shows how to use a custom rule (remark-lint-no-emphasis-as-heading) to lint a Markdown string.

const remark = require('remark');
const lint = require('remark-lint');
const noEmphasisAsHeading = require('remark-lint-no-emphasis-as-heading');

remark()
  .use(lint)
  .use(noEmphasisAsHeading)
  .process('# Hello *world*!', function (err, file) {
    console.error(report(err || file));
  });

Configurable Presets

remark-lint provides configurable presets that bundle multiple rules together for convenience. The code sample demonstrates how to use the 'remark-preset-lint-recommended' preset to lint a Markdown string.

const remark = require('remark');
const lint = require('remark-lint');
const presetLintRecommended = require('remark-preset-lint-recommended');

remark()
  .use(lint)
  .use(presetLintRecommended)
  .process('# Hello world!', function (err, file) {
    console.error(report(err || file));
  });

Other packages similar to remark-lint

Keywords

FAQs

Package last updated on 09 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc