Andreas/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-12-24 11:20:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
wekan/packages/markdown/marked/docs
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
..
demo Update markedjs package 2020-06-03 23:10:25 +02:00
img Include to Wekan packages directory contents, so that meteor command would build all directly. 2019-04-20 15:18:33 +03:00
.eslintrc.json Fix: img tag did not allow width and height. 2020-03-06 03:52:12 +02:00
AUTHORS.md Fix: img tag did not allow width and height. 2020-03-06 03:52:12 +02:00
broken.md Include to Wekan packages directory contents, so that meteor command would build all directly. 2019-04-20 15:18:33 +03:00
CNAME Include to Wekan packages directory contents, so that meteor command would build all directly. 2019-04-20 15:18:33 +03:00
CODE_OF_CONDUCT.md Include to Wekan packages directory contents, so that meteor command would build all directly. 2019-04-20 15:18:33 +03:00
CONTRIBUTING.md Fix: img tag did not allow width and height. 2020-03-06 03:52:12 +02:00
index.html Update markedjs package 2020-06-03 23:10:25 +02:00
PUBLISHING.md Fix: img tag did not allow width and height. 2020-03-06 03:52:12 +02:00
README.md Fix: img tag did not allow width and height. 2020-03-06 03:52:12 +02:00
USING_ADVANCED.md Update markedjs package 2020-06-03 23:10:25 +02:00
USING_PRO.md Update markedjs package 2020-06-03 23:10:25 +02:00

README.md

Marked is

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

* Still working on metrics for comparative analysis and definition.
** As few dependencies as possible.
*** Strict compliance could result in slower processing when running comparative benchmarking.

Demo

Checkout the demo page to see marked in action ⛹️

These 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>

$ marked -s "*hello world*"
<p><em>hello world</em></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 browser\n\nRendered by **marked**.');
  </script>
</body>
</html>

Marked offers advanced configurations and extensibility as well.

Supported Markdown specifications

We actively support the features of the following Markdown flavors.

Flavor Version
The original markdown.pl --
CommonMark 0.29
GitHub Flavored Markdown 0.29

By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community.

Security

The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously.

Therefore, please disclose potential security issues by email to the project committers as well as the listed owners within NPM. We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).