marked
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/marked package

    1.0.0 • Public • Published

    Marked

    npm gzip size install size downloads dep dev dep 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:

    Installation

    CLI: npm install -g marked

    In-browser: npm install marked

    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! 🚨

    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>
    </head>
    <body>
      <div id="content"></div>
      <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script> 
      <script>
        document.getElementById('content').innerHTML =
          marked('# Marked in the browser\n\nRendered by **marked**.');
      </script> 
    </body>
    </html>

    License

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

    Install

    npm i [email protected]

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    223 kB

    Total Files

    19

    Last publish

    Collaborators

    • chjj
    • styfle
    • amidknight
    • tonybrix