PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

5.0.5

npm

@03balogun/marked

A markdown parser built for speed

htmlmarkdownmarkup
Published30 May 2024
Direct dependencies27
Transitive dependenciesNot calculated

README

Current package documentation

Marked

npm gzip size install size downloads github actions snyk

  • ⚡ built for speed
  • ⬇️ low-level compiler for parsing markdown without caching or blocking for long periods of time
  • ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications
  • 🌐 works in a browser, on a server, or from a command line interface (CLI)

Demo

Checkout the demo page to see marked in action ⛹️

Docs

Our documentation pages are also rendered using marked 💯

Also read about:

Compatibility

Node.js: Only current and LTS Node.js versions are supported. End of life Node.js versions may become incompatible with Marked at any point in time.

Browser: Not IE11 :)

Installation

CLI:

npm install -g marked

In-browser:

npm install marked
npm install @types/marked # For TypeScript projects

Usage

Warning: 🚨 Marked does not sanitize the output HTML. Please use a sanitize library, like DOMPurify (recommended), sanitize-html or insane on the output HTML! 🚨

DOMPurify.sanitize(marked.parse(`<img src="x" onerror="alert('not happening')">`));

CLI

# Example with stdin input
$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

# Print all options
$ marked --help

Browser

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

License

Copyright (c) 2011-2022, Christopher Jeffrey. (MIT License)

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 27

Native requirements
27 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^8.42.0development
rollup
Environment
{
  "local_name": "rollup",
  "alias": false,
  "peer_metadata": null
}
^3.23.0development
cheerio
Environment
{
  "local_name": "cheerio",
  "alias": false,
  "peer_metadata": null
}
^1.0.0-rc.12development
jasmine
Environment
{
  "local_name": "jasmine",
  "alias": false,
  "peer_metadata": null
}
^5.0.0development
recheck
Environment
{
  "local_name": "recheck",
  "alias": false,
  "peer_metadata": null
}
^4.4.5development
titleize
Environment
{
  "local_name": "titleize",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development
uglify-js
Environment
{
  "local_name": "uglify-js",
  "alias": false,
  "peer_metadata": null
}
^3.17.4development
commonmark
Environment
{
  "local_name": "commonmark",
  "alias": false,
  "peer_metadata": null
}
0.30.0development
node-fetch
Environment
{
  "local_name": "node-fetch",
  "alias": false,
  "peer_metadata": null
}
^3.3.1development
@babel/core
Environment
{
  "local_name": "@babel/core",
  "alias": false,
  "peer_metadata": null
}
^7.22.1development
markdown-it
Environment
{
  "local_name": "markdown-it",
  "alias": false,
  "peer_metadata": null
}
13.0.1development
front-matter
Environment
{
  "local_name": "front-matter",
  "alias": false,
  "peer_metadata": null
}
^4.0.2development
highlight.js
Environment
{
  "local_name": "highlight.js",
  "alias": false,
  "peer_metadata": null
}
^11.8.0development
eslint-plugin-n
Environment
{
  "local_name": "eslint-plugin-n",
  "alias": false,
  "peer_metadata": null
}
^15.7.0development
semantic-release
Environment
{
  "local_name": "semantic-release",
  "alias": false,
  "peer_metadata": null
}
^21.0.3development
@babel/preset-env
Environment
{
  "local_name": "@babel/preset-env",
  "alias": false,
  "peer_metadata": null
}
^7.22.4development
vuln-regex-detector
Environment
{
  "local_name": "vuln-regex-detector",
  "alias": false,
  "peer_metadata": null
}
^1.3.0development
@rollup/plugin-babel
Environment
{
  "local_name": "@rollup/plugin-babel",
  "alias": false,
  "peer_metadata": null
}
^6.0.3development
eslint-plugin-import
Environment
{
  "local_name": "eslint-plugin-import",
  "alias": false,
  "peer_metadata": null
}
^2.27.5development
@markedjs/html-differ
Environment
{
  "local_name": "@markedjs/html-differ",
  "alias": false,
  "peer_metadata": null
}
^4.0.2development
@semantic-release/git
Environment
{
  "local_name": "@semantic-release/git",
  "alias": false,
  "peer_metadata": null
}
^10.0.1development
@semantic-release/npm
Environment
{
  "local_name": "@semantic-release/npm",
  "alias": false,
  "peer_metadata": null
}
^10.0.3development
eslint-plugin-promise
Environment
{
  "local_name": "eslint-plugin-promise",
  "alias": false,
  "peer_metadata": null
}
^6.1.1development
eslint-config-standard
Environment
{
  "local_name": "eslint-config-standard",
  "alias": false,
  "peer_metadata": null
}
^17.1.0development
@semantic-release/github
Environment
{
  "local_name": "@semantic-release/github",
  "alias": false,
  "peer_metadata": null
}
^9.0.2development
@semantic-release/commit-analyzer
Environment
{
  "local_name": "@semantic-release/commit-analyzer",
  "alias": false,
  "peer_metadata": null
}
^10.0.0development
@semantic-release/release-notes-generator
Environment
{
  "local_name": "@semantic-release/release-notes-generator",
  "alias": false,
  "peer_metadata": null
}
^11.0.2development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "8f73de1790fab1efc06fd3850237ab4640ac3106",
  "tarball": "https://registry.npmjs.org/@03balogun/marked/-/marked-5.0.5.tgz",
  "fileCount": 21,
  "integrity": "sha512-bz3LnjTeaG6EBrH2gkeVP2lzmFvtq2q+sC4kA+Jch9CsVwHyi1gYGoTpTQM1fmEfSmEhxnyH5jG6PrAUcxNqjg==",
  "signatures": [
    {
      "sig": "MEUCIQDFJuuB3wbLssEwuSbLALQqF8MrsTtlk7Pnn3OcWbmcbwIgYRdzXrniEa6GE1/xxfbOiMgF5B+bm6uwhll18eSezmY=",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 443000
}

Repository

PENDING
markedjs/marked

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 22:00 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:3d65f465ef28a8d7da5a0cabc1fbe1bb76b680c14134438e4d42d03cb1f0da55

Other collected versions

5.0.630 MayView all collected versions →