Speed-highlight JS

Light, fast, and easy to use, dependencies free javascript syntax highlighter, with automatic language detection, try it out here

Light 📦

• The core is about 1kB (gzipped & minified)
• Languages definition are from a few bytes to 1kB
• Themes are about 1kB
• Language rules needed are automatically loaded

Fast ⚡

Blazing fast highlighting using regex

Simple setup 🚀

Web

Style/theme (in the header of your html file):

In the body of your html file:

<div class="shj-lang-[code-language]">[code]</div>
or
<code class="shj-lang-[code-language]">[inline code]</code>

Highlight the code (in your javascript):

import { highlightAll } from '/path/dist/index.js';
highlightAll();

Auto language detection

import { highlightElement } from '../src/index.js';
import { detectLanguage } from '../src/detect.js';

elm.textContent = code;
highlightElement(elm, detectLanguage(code));

Load custom language

import { loadLanguage } from '../src/index.js';

loadLanguage('language-name', customLanguage);

CDN

import ... from 'https://unpkg.com/@speed-highlight/core/dist/index.js';
import ... from 'https://cdn.jsdelivr.net/gh/speed-highlight/core/dist/index.js';

Deno

Use the deno module

import { setTheme, printHighlight } from 'https://x.nest.land/speed_highlight_js/dist/terminal.js';

await setTheme('[theme-name]');
printHighlight('console.log("hello")', 'js');

Node

Use the npm package

npm i @speed-highlight/core

const { setTheme, printHighlight } = require('@speed-highlight/core/terminal');

setTheme('[theme-name]');
printHighlight('console.log("hello")', 'js');

Migrating from prism

Speed-highlight JS is a lighter and faster version of prism that share a similar API

Style

Remove the prism stylesheet in the head of your html file Clone this repository or use a cdn to load our stylesheet

-  
+  

Script

For the script part remove the prism.js script and replace it by a import and a call to highlightAll

-  
+

If you want to highlight only a specific element you can use the highlightElement function instead

Code block

For the code blocks replace the <pre><code> by only one <div> And use shj-lang- prefix instead of language- for the class property

-<pre><code class="language-css">p { color: red }</code></pre>
+<div class="shj-lang-css">p { color: red }</div>

And for inline code block you just have to change the class property

-<code class="language-css">p { color: red }</code>
+<code class="shj-lang-css">p { color: red }</code>

Languages supported 🌐

Themes 🌈

A modern theme by default

Documentation 👀

Further in-depth documentation for the API and other topics is in our Wiki and our Documentation

License 📃

Shj is released under the Creative Commons Zero License. See our LICENSE file for details.