mirror of https://github.com/wekan/wekan.git synced 2025-12-24 11:20:13 +01:00

History

Marc Hartmayer 399ddd2dab Update `markedjs` package Update `markedjs` to commit `7b3036f8c0`. This fixes the issue https://github.com/wekan/wekan/issues/3148.		2020-06-03 23:10:25 +02:00
..
docs	Update `markedjs` package	2020-06-03 23:10:25 +02:00
lib	Update `markedjs` package	2020-06-03 23:10:25 +02:00
man	Fix: img tag did not allow width and height.	2020-03-06 03:52:12 +02:00
LICENSE.md	Include to Wekan packages directory contents, so that meteor command would build all directly.	2019-04-20 15:18:33 +03:00
package-lock.json	Update `markedjs` package	2020-06-03 23:10:25 +02:00
package.json	Update `markedjs` package	2020-06-03 23:10:25 +02:00
README.md	Fix: img tag did not allow width and height.	2020-03-06 03:52:12 +02:00
SECURITY.md	Fix: img tag did not allow width and height.	2020-03-06 03:52:12 +02:00

README.md

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 to see marked in action ⛹️

Docs

Our documentation pages are also rendered using marked 💯

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>