This loader can apply syntax-highlighting via highlight.js in two ways:
-
Given HTML (either straight HTML or the output of something like markdown-loader), it will replace the contents of
<code>
blocks with syntax-highlighted HTML generated by highlight.js. This is the default behavior. -
Given a raw file, it will return syntax-highlighted HTML generated by highlight.js. This can be enabled by using the
raw
parameter.
You probably want to pass the HTML output of this loader through html-loader.
If any value is provided, the loader will interpret its input as a raw string to run through highlight.js.
By default, the language is auto-detected. To specify a language, use the lang
parameter.
Specify a language for highlight.js. Only works in combination with the raw
parameter.
(To specify a language for non-raw input, apply lang-[something]
classes to your <code>
blocks.)
// Reading HTML from parsed markdown ...
var highlightedMarkdown = require('html!highlight!markdown!./README.md');
// Reading a file's raw contents and auto-detecting the language ...
var highlightedRaw = require('html!highlight?raw=true!./example-script.js');
// Reading a file's raw contents and specifying the language ...
var highlightedRawCss = require('html!highlight?raw=true&lang=css!./example-stylesheet.css');
- David Clark - Added
raw
andlang
parameters - Zane Miller - Added missing
hljs
class topre
element - Javier Castro - Add Node.js support
highlight-loader is available under MIT. See LICENSE for more details.