<commit_before>```
   _           _   _ _       _     _ _       _     _   
  (_)_ __ ___ | | | (_) __ _| |__ | (_) __ _| |__ | |_ 
  | | '_ ` _ \| |_| | |/ _` | '_ \| | |/ _` | '_ \| __|
  | | | | | | |  _  | | (_| | | | | | | (_| | | | | |_ 
 _/ |_| |_| |_|_| |_|_|\__, |_| |_|_|_|\__, |_| |_|\__|
|__/                   |___/           |___/           
```

#### JavaScript keyword highlighting. Can be used e.g. to highlight text in search results.

[![Dependency Status](https://img.shields.io/versioneye/d/javascript/julmot:jmhighlight.svg)](https://www.versioneye.com/user/projects/55893384306662001e0000e8)
[![Build Status](https://img.shields.io/travis/julmot/jmHighlight.svg)](https://travis-ci.org/julmot/jmHighlight)
[![Codacy Badge](https://img.shields.io/codacy/27a3ed45370f41e89b02073b214c18a7.svg)](https://www.codacy.com/app/julmot/jmHighlight)
[![Issue Stats](http://issuestats.com/github/julmot/jmHighlight/badge/issue?style=flat)](http://issuestats.com/github/julmot/jmHighlight)
[![Bower version](https://img.shields.io/bower/v/jmHighlight.svg)](https://github.com/julmot/jmHighlight)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/julmot/jmHighlight/master/LICENSE)

##1. Getting started

Choose between:
- Run `$ bower install jmHighlight --save-dev`
- Download "[dist/jquery.jmHighlight.min.js](https://github.com/julmot/jmHighlight/blob/master/dist/jquery.jmHighlight.min.js)" and include it in your project (Note: the file must be saved as UTF-8)

You are ready to start!

*Note: jmHighlight is a jQuery plugin compatible with RequireJS, NodeJS/CommonJS or without any module loader! Howsoever you are using it, make sure that jQuery is embedded.*

##2. Highlight usage

Syntax:
```javascript
$(".context").jmHighlight(keyword [, options]);
```

Parameters:

_**keyword**_: A JavaScript string containing the keyword. Note that this will be escaped.

_**options**_: A JavaScript object containing optional settings:

| Option             | Type    | Default     | Description                                                                                                                                                         |
|--------------------|---------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|<commit_msg>Use master branch Travis CI badge<commit_after>```
   _           _   _ _       _     _ _       _     _   
  (_)_ __ ___ | | | (_) __ _| |__ | (_) __ _| |__ | |_ 
  | | '_ ` _ \| |_| | |/ _` | '_ \| | |/ _` | '_ \| __|
  | | | | | | |  _  | | (_| | | | | | | (_| | | | | |_ 
 _/ |_| |_| |_|_| |_|_|\__, |_| |_|_|_|\__, |_| |_|\__|
|__/                   |___/           |___/           
```

#### JavaScript keyword highlighting. Can be used e.g. to highlight text in search results.

[![Dependency Status](https://img.shields.io/versioneye/d/javascript/julmot:jmhighlight.svg)](https://www.versioneye.com/user/projects/55893384306662001e0000e8)
[![Build Status](https://travis-ci.org/julmot/jmHighlight.svg?branch=master)](https://travis-ci.org/julmot/jmHighlight)
[![Codacy Badge](https://img.shields.io/codacy/27a3ed45370f41e89b02073b214c18a7.svg)](https://www.codacy.com/app/julmot/jmHighlight)
[![Issue Stats](http://issuestats.com/github/julmot/jmHighlight/badge/issue?style=flat)](http://issuestats.com/github/julmot/jmHighlight)
[![Bower version](https://img.shields.io/bower/v/jmHighlight.svg)](https://github.com/julmot/jmHighlight)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/julmot/jmHighlight/master/LICENSE)

##1. Getting started

Choose between:
- Run `$ bower install jmHighlight --save-dev`
- Download "[dist/jquery.jmHighlight.min.js](https://github.com/julmot/jmHighlight/blob/master/dist/jquery.jmHighlight.min.js)" and include it in your project (Note: the file must be saved as UTF-8)

You are ready to start!

*Note: jmHighlight is a jQuery plugin compatible with RequireJS, NodeJS/CommonJS or without any module loader! Howsoever you are using it, make sure that jQuery is embedded.*

##2. Highlight usage

Syntax:
```javascript
$(".context").jmHighlight(keyword [, options]);
```

Parameters:

_**keyword**_: A JavaScript string containing the keyword. Note that this will be escaped.

_**options**_: A JavaScript object containing optional settings:

| Option             | Type    | Default     | Description                                                                                                                                                         |
|--------------------|---------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
{'fraction_non_alphanumeric': 0.23448979591836736, 'fraction_numerical': 0.019591836734693877, 'mean_word_length': 1.9793313069908816, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 22, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 23, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1901873', 'n_tokens_mistral': 1607, 'n_tokens_neox': 1427, 'n_words': 235}