gulp-highlight-code v1.0.8

gulp-highlight-code

Check it out on npm!

About

Pipe code snippets through highlight.js using gulp to pre-tag code blocks at compile time. This only applies to codeblocks formatted properly using both the pre and a code tags (i.e. <pre><code>).

gulp-highlight-code will try to automatically detect a codeblock's language. To improve the accuracy of gulp-highlight-code, add the data-lang HTML attribute to the code tag containing code block to specify the language.

Install

npm install gulp-highlight-code --save-dev

Usage

gulpfile.js

var gulp = require('gulp');
var highlight = require('gulp-highlight-code');

gulp.task('default', function () {
	gulp.src('src/index.html')
		.pipe(highlight())
		.pipe(gulp.dest('dist'));
});

src/index.html

<!-- Will be highlighted -->
<pre><code data-lang="html">&lt;div&gt;
	Highlighted
&lt;div&gt;</code></pre>

<!-- Will not be highlighted -->
<pre><code data-lang="html" class="no-highlight">&lt;div&gt;
	Not Highlighted
&lt;div&gt;</code></pre>

Notes

• You must use escaped HTML within the <pre><code> block.

• Code blocks that have been highlighted using highlight.js will have the hljs class added to them. Similarly, code blocks that were not highlighted will have the no-hljs class added to them.

Known Issues

• No CSS is included. This is intentional as this library is only intended to pre-wrap code snippets within code blocks using highlight.js tags. You are required to define and include your own CSS.