Socket
Socket
Sign inDemoInstall

remark

Package Overview
Dependencies
Maintainers
2
Versions
49
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

remark

markdown processor powered by plugins part of the unified collective


Version published
Weekly downloads
1.9M
decreased by-5.1%
Maintainers
2
Weekly downloads
 
Created

What is remark?

The remark npm package is a powerful, extensible Markdown processor built on the unified collective ecosystem. It allows for parsing, transforming, and compiling Markdown content with a focus on syntax trees. Remark can be used for a variety of tasks such as linting Markdown, transforming the syntax for different purposes, or extracting metadata from documents.

What are remark's main functionalities?

Parsing Markdown to Syntax Trees

This feature allows users to parse Markdown content into an abstract syntax tree (AST), enabling programmatic analysis and manipulation of the content.

const remark = require('remark');
const markdown = 'Some **Markdown** text.';
remark().parse(markdown);

Transforming Syntax Trees

With this feature, users can transform the syntax tree generated from Markdown content. For example, converting the tree to HTML by using the remark-html plugin.

const remark = require('remark');
const html = require('remark-html');
const markdown = 'Some **Markdown** text.';
remark().use(html).processSync(markdown).toString();

Linting Markdown

This feature enables users to lint their Markdown content for style and syntax issues, ensuring consistency and quality in their Markdown files.

const remark = require('remark');
const recommended = require('remark-preset-lint-recommended');
const report = require('vfile-reporter');

remark().use(recommended).process('_Emphasis_ and **importance**', (err, file) => {
  console.error(report(err || file));
});

Other packages similar to remark

Keywords

FAQs

Package last updated on 18 Sep 2023

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