Have ideas to improve npm?Join in the discussion! ¬Ľ

    This version has been deprecated

    Author message:

    Version no longer supported. Upgrade to @latest

    TypeScript icon, indicating that this package has built-in type declarations



    Build Status Greenkeeper badge

    Highlight.js is a syntax highlighter written in JavaScript. It works in the browser as well as on the server. It works with pretty much any markup, doesn’t depend on any framework, and has automatic language detection.

    Getting Started

    The bare minimum for using highlight.js on a web page is linking to the library along with one of the styles and calling initHighlightingOnLoad:

    <link rel="stylesheet" href="/path/to/styles/default.css">
    <script src="/path/to/highlight.pack.js"></script>

    This will find and highlight code inside of <pre><code> tags; it tries to detect the language automatically. If automatic detection doesn’t work for you, you can specify the language in the class attribute:

    <pre><code class="html">...</code></pre>

    The list of supported language classes is available in the class reference. Classes can also be prefixed with either language- or lang-.

    To make arbitrary text look like code, but without highlighting, use the plaintext class:

    <pre><code class="plaintext">...</code></pre>

    To disable highlighting altogether use the nohighlight class:

    <pre><code class="nohighlight">...</code></pre>

    Custom Initialization

    When you need a bit more control over the initialization of highlight.js, you can use the highlightBlock and configure functions. This allows you to control what to highlight and when.

    Here’s an equivalent way to calling initHighlightingOnLoad using vanilla JS:

    document.addEventListener('DOMContentLoaded', (event) => {
      document.querySelectorAll('pre code').forEach((block) => {

    You can use any tags instead of <pre><code> to mark up your code. If you don't use a container that preserves line breaks you will need to configure highlight.js to use the <br> tag:

    hljs.configure({useBR: true});
    document.querySelectorAll('div.code').forEach((block) => {

    For other options refer to the documentation for configure.

    Web Workers

    You can run highlighting inside a web worker to avoid freezing the browser window while dealing with very big chunks of code.

    In your main script:

    addEventListener('load', () => {
      const code = document.querySelector('#code');
      const worker = new Worker('worker.js');
      worker.onmessage = (event) => { code.innerHTML = event.data; }

    In worker.js:

    onmessage = (event) => {
      const result = self.hljs.highlightAuto(event.data);

    Getting the Library

    You can get highlight.js as a hosted, or custom-build, browser script or as a server module. Right out of the box the browser script supports both AMD and CommonJS, so if you wish you can use RequireJS or Browserify without having to build from source. The server module also works perfectly fine with Browserify, but there is the option to use a build specific to browsers rather than something meant for a server. Head over to the download page for all the options.

    Don't link to GitHub directly. The library is not supposed to work straight from the source, it requires building. If none of the pre-packaged options work for you refer to the building documentation.

    The CDN-hosted package doesn't have all the languages. Otherwise it'd be too big. If you don't see the language you need in the "Common" section, it can be added manually:


    On Almond. You need to use the optimizer to give the module a name. For example:

    r.js -o name=hljs paths.hljs=/path/to/highlight out=highlight.js


    You can import Highlight.js as a CommonJS-module:

    npm install highlight.js --save

    In your application:

    import hljs from 'highlight.js';

    The default import imports all languages! Therefore it is likely to be more efficient to import only the library and the languages you need:

    import hljs from 'highlight.js/lib/highlight';
    import javascript from 'highlight.js/lib/languages/javascript';
    hljs.registerLanguage('javascript', javascript);

    To set the syntax highlighting style, if your build tool processes CSS from your JavaScript entry point, you can import the stylesheet directly into your CommonJS-module:

    import hljs from 'highlight.js/lib/highlight';
    import 'highlight.js/styles/github.css';


    Highlight.js is released under the BSD License. See LICENSE file for details.


    The official site for the library is at https://highlightjs.org/.

    Further in-depth documentation for the API and other topics is at http://highlightjs.readthedocs.io/.

    Authors and contributors are listed in the AUTHORS.en.txt file.


    npm i [email protected]





    Unpacked Size

    1.26 MB

    Total Files


    Last publish


    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar