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

marked

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

marked

A markdown parser built for speed

0.3.19
Source
npm

Version published: 7 years ago

Weekly downloads: 13M; increased by2.93%

Maintainers: 2

Weekly downloads

Created: 13 years ago

What is marked?

The marked npm package is a markdown parser and compiler built for speed. It converts markdown syntax to HTML, and it is designed to be as extensible and fast as possible.

What are marked's main functionalities?

Markdown Parsing

This feature allows you to parse markdown text and convert it to HTML. The code sample shows how to use marked to convert a simple markdown string into HTML.

const marked = require('marked');
console.log(marked('# Marked in Node.js\n\nRendered by **marked**.'));

Options Customization

This feature allows you to customize the behavior of the marked parser by setting options such as GitHub Flavored Markdown (GFM), breaks, pedantic, sanitize, smart lists, and smartypants.

const marked = require('marked');
marked.setOptions({
  renderer: new marked.Renderer(),
  gfm: true,
  breaks: false,
  pedantic: false,
  sanitize: false,
  smartLists: true,
  smartypants: false
});
console.log(marked('I am using __markdown__.'));

Synchronous Parsing

This feature allows you to parse markdown synchronously, which is useful when you don't need to handle asynchronous operations.

const marked = require('marked');
const html = marked('## Synchronous markdown to HTML');
console.log(html);

Asynchronous Parsing

This feature allows you to parse markdown asynchronously, which can be useful when dealing with file systems or network requests.

const marked = require('marked');
marked('# Asynchronous markdown to HTML', function(err, content) {
  if (err) throw err;
  console.log(content);
});

Lexer and Parser

This feature exposes the lexer and parser, allowing you to generate tokens from markdown and then parse those tokens into HTML. This can be useful for advanced use-cases where you need to manipulate the tokens before parsing.

const marked = require('marked');
const tokens = marked.lexer('# Lexing markdown');
console.log(tokens);
const html = marked.parser(tokens);
console.log(html);

Other packages similar to marked

Marked

Marked is

built for speed.
a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.
light-weight while implementing all markdown features from the supported flavors & specifications.
available as a command line interface (CLI) and running in client- or server-side JavaScript projects.

Installation

CLI: npm install -g marked

In-browser: npm install marked --save

Usage

CLI

$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

Browser

<!doctype html>
<html>
<head>
  <meta charset="utf-8"/>
  <title>Marked in the browser</title>
  <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
</head>
<body>
  <div id="content"></div>
  <script>
    document.getElementById('content').innerHTML =
      marked('# Marked in the browser\n\nRendered by **marked**.');
  </script>
</body>
</html>

License

Keywords

FAQs

What is marked?

Is marked popular?

Is marked well maintained?

Package last updated on 26 Mar 2018

Did you know?

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