# angular-highlightjs
AngularJS directive for syntax highlighting with [highlight.js](http://highlightjs.org/).
#### [Demo](http://plnkr.co/edit/OPxzDu?p=preview)
## Requirements
* Highlight.js (.js & .css)
* AngularJS v1.0.1+
## Getting started
Follow the instructions [here](http://softwaremaniacs.org/soft/highlight/en/download/) to setup highlight.js.
Using a prebuilt version of highlight.js hosted at Yandex here.
```html
```
Include `angular-highlightjs` module script with AngularJS script on your page.
```html
```
Add `hljs` to your app module's dependency.
```js
angular.module('myApp', ['hljs']);
```
## Install with Bower
Note that the `angular-highlightjs` bower package contains no AngularJS dependency.
```sh
# install AngularJS (stable)
bower install angular
# or (unstable)
bower install PatternConsulting/bower-angular
# install angular-highlightjs & highlightjs
bower install angular-highlightjs
```
## Usage
### hljs
This is a required directive. Without any other supportive directives, it provides basic inline highlight function. For better understanding, some notes about using it are specified in the live example page.
[Live example](http://pc035860.github.io/angular-highlightjs/example/#/hljs)
```html
```
#### source (optional)
Type: `expression`
Default: `undefined`
If `source` is presented, the `hljs` directive will evaluate the expression and highlight the result string. This is pretty useful for dynamically changed content.
[Live example](http://pc035860.github.io/angular-highlightjs/example/#/hljs-source)
Dynamically changed content.
```html
```
The expression. Beware of single-quotes.
```html
```
#### include (optional)
Type: `expression`
Default: `undefined`
Works as the built-in `ng-include` directive, utilizes `$templateCache` and `$http` to retrieve content from `text/ng-template` scripts or from XHR.
[Live example](http://pc035860.github.io/angular-highlightjs/example/#/hljs-include)
From `text/ng-template` script `localOne`. Beware of single-quotes in the expression.
```html
```
From `partials/lang-perl` XHR. Again, beware of single-quotes.
```html
```
#### language (optional)
Type: `string`
Default: `undefined`
Tells the highlight.js which language syntax should be used to highlight the codes. If not specified, highlight.js will highlight with built-in language detection.
[Live example](http://pc035860.github.io/angular-highlightjs/example/#/hljs-language)
```html
```
### Happy highlighting!!!