Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chjj/marked

A markdown parser and compiler. Built for speed.
https://github.com/chjj/marked

commonmark compiler gfm hacktoberfest markdown parser

Last synced: about 2 months ago
JSON representation

A markdown parser and compiler. Built for speed.

Host: GitHub
URL: https://github.com/chjj/marked
Owner: markedjs
License: other
Created: 2011-07-24T13:15:51.000Z (about 13 years ago)
Default Branch: master
Last Pushed: 2024-04-29T16:38:17.000Z (5 months ago)
Last Synced: 2024-05-01T20:51:45.085Z (5 months ago)
Topics: commonmark, compiler, gfm, hacktoberfest, markdown, parser
Language: JavaScript
Homepage: https://marked.js.org
Size: 9.44 MB
Stars: 31,924
Watchers: 387
Forks: 3,349
Open Issues: 25
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-node-modules - marked - A full-featured markdown parser and compiler, written in JavaScript. Built for speed. (Uncategorized / Uncategorized)
awesome-development - marked - A markdown parser and compiler built for speed. (Packages / Parsing)
awesome - marked - A full-featured markdown parser and compiler, written in JavaScript. Built for speed. (Packages / Template Engine)

README

        

  



# Marked

[![npm](https://badgen.net/npm/v/marked)](https://www.npmjs.com/package/marked)

[![gzip size](https://badgen.net/badgesize/gzip/https://cdn.jsdelivr.net/npm/marked/marked.min.js)](https://cdn.jsdelivr.net/npm/marked/marked.min.js)

[![install size](https://badgen.net/packagephobia/install/marked)](https://packagephobia.now.sh/result?p=marked)

[![downloads](https://badgen.net/npm/dt/marked)](https://www.npmjs.com/package/marked)

[![github actions](https://github.com/markedjs/marked/workflows/Tests/badge.svg)](https://github.com/markedjs/marked/actions)

[![snyk](https://snyk.io/test/npm/marked/badge.svg)](https://snyk.io/test/npm/marked)

- ⚡ 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](https://marked.js.org/demo/) to see marked in action ⛹️

## Docs

Our [documentation pages](https://marked.js.org) are also rendered using marked 💯

Also read about:

* [Options](https://marked.js.org/using_advanced)

* [Extensibility](https://marked.js.org/using_pro)

## Compatibility

**Node.js:** Only [current and LTS](https://nodejs.org/en/about/releases/) 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:**

```sh

npm install -g marked

```

**In-browser:**

```sh

npm install marked

```

## Usage

### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/using_advanced#options) the output HTML. Please use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the *output* HTML! 🚨

```

DOMPurify.sanitize(marked.parse(``));

```

**CLI**

``` bash

# Example with stdin input

$ marked -o hello.html

hello world

^D

$ cat hello.html

hello world

```

```bash

# Print all options

$ marked --help

```

**Browser**

```html

  

  Marked in the browser

  


  

  

    document.getElementById('content').innerHTML =

      marked.parse('# Marked in the browser\n\nRendered by **marked**.');

  

```

or import esm module

```html

  import { marked } from "https://cdn.jsdelivr.net/npm/marked/lib/marked.esm.js";

  document.getElementById('content').innerHTML =

    marked.parse('# Marked in the browser\n\nRendered by **marked**.');

```

## License

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