Git Product home page Git Product logo

ultramarked's Introduction

ultramarked

Marked with built-in syntax highlighting and input sanitizing that doesn't encode all HTML.

Ultramarked wraps around marked, so it's essentially Marked, with a few extra options.

Fetch

$ npm install ultramarked --save

Use

var ultramarked = require('ultramarked');

ultramarked.setOptions({
    // your options go here
});

ultramarked('This is **awesome**!');

Configure

options.ultralight

Syntax highlighting powered by highlight.js, no extra magic. Classes are prefixed hljs for convenience. Note that the renderer you choose will be overridden.

options.ultrasanitize

As of right now, Marked encodes all HTML input when sanitize = true. Set this option to true to use the AngularJS Sanitizer sanitizer, tweaked to disallow script and style tags.

options.iframes

If you are using ultrasanitize, you can pass in an array of strings or regular expressions that match permitted iframe targets. Regular expressions are tested against user input, and strings are interpreted as the beginning of a URL. This means that an string like 'http://google.com' will match any URL in the google.com domain that uses the HTTP protocol.

options.terminal

Prettifies the code for terminal output! Incompatible with ultralight, which will be disabled when terminal is enabled. Also turns off ultrasanitize, because color codes. Luckily none of that will be an issue when rendering HTML for the terminal!

terminal.png

options.sanitizer

Angular's sanitizer option might be too lenient for you. If that's the case, you can use PageDown's white-list instead, which is much more narrow, and doesn't allow setting class attributes, for example.

ultramarked.setOptions({
	sanitizer: require('pagedown-sanitizer')
});

ultramarked's People

Contributors

bevacqua avatar mathiasbynens avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.