Applies highlight.js to given HTML
npm install highlight-loader
This loader can apply syntax-highlighting via highlight.js in two ways:
1. Given HTML (either straight HTML or the output of something like markdown-loader), it will replace the contents of blocks with syntax-highlighted HTML generated by highlight.js. This is the default behavior.
2. 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 blocks.)
Execute the input that highlight-loader receives. Useful in cases when chaining another loader which returns a function. One use case is to combine this with the apply-loader.
By default, exec is false and simply treats its input as a string.
Install with npm:
``bash`
npm install highlight-loader --save-dev
Make sure highlightjs is included and initialized on your page.
Add highlight-loader as a webpack loader:
`javascript`
module: {
loaders: [
{
test: /\.md$/,
loader: 'html!highlight!markdown',
include: PATHS.markdown
}
]
}
`javascript
// 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');
// Reading HTML from a template loader
var highlightedRenderedJadeTemplate = require('html!highlight?exec!apply!jade!./index.jade')
`
* David Clark - Added raw and lang parametershljs
* Zane Miller - Added missing class to pre elementexec` parameter
* Javier Castro - Added Node support
* Sidd Sridharan - Added support for
* M.K. Safi - Added installation instructions
highlight-loader is available under MIT. See LICENSE for more details.