https://github.com/jstransformers/jstransformer-highlight

Highlight.js support for JSTransformers.
https://github.com/jstransformers/jstransformer-highlight

Last synced: 11 months ago
JSON representation

Highlight.js support for JSTransformers.

• Host: GitHub
• URL: https://github.com/jstransformers/jstransformer-highlight
• Owner: jstransformers
• License: mit
• Created: 2015-02-09T09:19:14.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-02-03T10:21:08.000Z (over 3 years ago)
• Last Synced: 2024-11-09T08:45:03.839Z (over 1 year ago)
• Language: JavaScript
• Homepage: http://npmjs.com/jstransformer-highlight
• Size: 58.6 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# jstransformer-highlight

[Highlight.js](http://highlightjs.org) support for [JSTransformers](http://github.com/jstransformers).

[![Build Status](https://img.shields.io/travis/jstransformers/jstransformer-highlight/master.svg)](https://travis-ci.org/jstransformers/jstransformer-highlight)

[![Coverage Status](https://img.shields.io/codecov/c/github/jstransformers/jstransformer-highlight/master.svg)](https://codecov.io/gh/jstransformers/jstransformer-highlight)

[![Dependency Status](https://img.shields.io/david/jstransformers/jstransformer-highlight/master.svg)](http://david-dm.org/jstransformers/jstransformer-highlight)

[![NPM version](https://img.shields.io/npm/v/jstransformer-highlight.svg)](https://www.npmjs.org/package/jstransformer-highlight)

### Options

 - `lang` - The language the code is in

 - `auto` - defaults to `true` if `lang` is undefined.  Set this to `true` to have highlight.js auto-detect the language.  Set this to `false` to disable auto-detection even when there is no `lang` option.

### Example

```js

var highlight = require('jstransformer')(require('jstransformer-highlight'))

highlight.render('var i = 5 + 10;', { lang: 'javascript' }).body

//=> 'var i = 5 + 10;'

```

## License

MIT