Giter Club home page Giter Club logo

highlighter's Introduction

Highlighter

NPM version NPM downloads Build status Test coverage Greenkeeper badge

Highlighter provides a simple way to add syntax highlighting to all files by using highlight.js. Comes with built-in syntax highlighting for diffs and patches.

Installation

npm install highlighter --save

Usage

var highlight = require('highlighter')();

Basic Usage

Highlighter can be used programmatically, by passing in the source string and the source language.

highlight('var foo = "bar";', 'javascript'); //=> '<span class="hljs-keyword">var</span> foo = <span class="hljs-string">"bar"</span>'

Markdown Parser

Highlighter returns a function that supports most markdown parsers already.

var marked = require('marked');

marked.setOptions({
  highlight: highlight
});

Diff Support

Highlighter comes with complete diff support by appending .diff or .patch to the language name. This will wrap each section in a span with the section type class (diff-addition, diff-deletion, diff-header, diff-chunk or diff-null).

highlight('+var foo = "bar";', 'js.diff'); //=> '<span class="diff-addition"><span class="hljs-keyword">var</span> foo = <span class="hljs-string">"bar"</span>;</span>'

This also works within Markdown files. The primary drawback of this approach causes the parent <code> element to have the class appended with .diff or .patch, which may cause your specific CSS rules to fail. For example, <code class="lang-javascript.diff">.

```javascript.diff
+var foo = "bar";
```

License

MIT

highlighter's People

Contributors

blakeembrey avatar greenkeeperio-bot avatar greenkeeper[bot] avatar

Watchers

Dave Stevens 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.