Security
Very grateful to Michael Schmidt for all the help.
A largish release with many improvements and fixes from quite a few different contributors. Enjoy!
Deprecations:
requireLanguage is deprecated.
getLanguage (with custom error handling) or built-time dependencies.Parser:
beginKeywords support (#2813) Josh GoebelclassNameAliases for more complex grammars Josh GoebelNew Languages:
node-repl for Node.js REPL sessions (#2792) Marat NagayevLanguage Improvements:
~ (#2859) Guillaume Grossetie\ (#2861) Guillaume Grossetie\[Gamma]# Marcus Ortizsome keyword Marcus Ortiz@main attribute Marcus OrtizDev Improvements:
New themes:
Prior version let some look-behind regex sneak in, which does not work yet on Safari. This release removes those incompatible regexes.
Fix:
Language Improvements:
enum (struct|class) and union (#2752) Josh Goebel{} inside template literals SUBST expression (#2748) Josh Goebelconstructor is now highlighted as a function title (not keyword) (#2727) Josh Goebel# for private class fields (#2701) Chris Krycho(*) from being detected as a multi-line comment Josh Goebelobjective-c++ and obj-c++ aliases for Objective-C Josh Goebelrecord (#2685) Josh Goebeltitle (#2683) Josh Goebelfinal) in class declaration (#2696) Josh Goebelmatch keyword and add php8 as an alias (#2733) Ayesh KarunaratneDeprecations:
useBR option deprecated and will be removed in v11.0. (#2559) Josh GoebelParser Engine:
Parser Engine:
New themes:
Deprecations:
fixMarkup is now deprecated and will be removed in v11.0. (#2534) Josh GoebelBig picture:
Language Improvements:
init and record keywords for C# 9.0 (#2660) Youssef Victorarguments keyword and fix enumeration keyword (#2619) Andrew JankegetLanguage (#2636) nightenum, which will identify as a class now (#2643) ezksdFixes:
index.d.ts is not a module error (#2603) Josh GoebelNew themes:
Parser Engine:
keywords.$pattern key to grammar definitions (#2519) Josh GoebelregisterAliases method (#2540) Taufik Nurrohmanon:begin callback for modes (#2261) Josh Goebelon:end callback for modes (#2261) Josh GoebelEND_SAME_AS_BEGIN mode to replace endSameAsBegin parser attribute (#2261) Josh GoebelfixMarkup would rarely destroy markup when useBR was enabled (#2532) Josh GoebelDeprecations:
htmlbars grammar is now deprecated. Use handlebars instead. (#2344) Nils KnappmeierhighlightBlock result.re deprecated. Use result.relevance instead. (#2552) Josh Goebelresult.second_best.re => result.second_best.relevance (#2552)lexemes is now deprecated in favor of keywords.$pattern key (#2519) Josh GoebelendSameAsBegin is now deprecated. (#2261) Josh GoebelLanguage Improvements:
readonly keyword (#2562) Martin (Lhoerion)OPTIMIZE: and HACK: to the labels highlighted inside comments Josh Goebelpair, make_pair, priority_queue as built-ins (#2538) Hankun Linpriority_queue pair as cpp containers (#2541) Hankun Linset keyword conflicting with setTimeout, etc. (#2514) Vania Kucher=> function with nested () in params now works (#2502) Josh Goebel=> function with nested () in params now works (#2502) Josh Goebel@objcMembers was being partially highlighted (#2543) Nick Randalllate and required keywords, the Never built-in type, and nullable built-in types (#2550) Sam RawlinsBrower build:
Parser Engine Changes:
Parser Engine Changes:
New languages:
python-repl for Python REPL sessionsNew themes:
Parser Engine Changes:
beginKeywords to ignore . matches (#2434) Josh Goebelbefore:highlight plugin API callback (#2395) Josh Goebelafter:highlight plugin API callback (#2395) Josh Goebelname attribute now (#2400) Josh GoebelnoHighlightRe and languagePrefixRe configurable (#2374) Josh GoebelLanguage Improvements:
compactMap to keywords as built_in (#2478) Omid Golparvarfunc keyword (#2468) Adnan Yaqoobdefn- properly (#2438) Josh Goebel@identifier style identifiers (#2414) Josh Goebeldeny and allow keywords Josh Goebel<?= syntax to meta Taufik Nurrohmanrpc when followed by a block (#) Josh Goebelwhere keyword as class constraint (#2378) Josh Goebeltext and txt as alias (#2360) Taufik NurrohmanDeveloper Tools:
Grammar Improvements:
New languages:
New themes:
Core Changes:
Language Improvements:
block and endblock keywords (#2343) Philipp EngelA::typeName func(...)) (#2332) Josh GoebelA::functionName) (#2332) Josh Goebelint8_t, etc.) as function types (#2332) Josh GoebelDeveloper Tools:
Fixes:
New languages:
New themes:
Core Improvements:
createElementNS to createElement (#2314) Josh Goebelself mode at the top-level of a language (#2294) Josh GoebelLanguage Improvements:
if getting confused as an f-string (#2200) Josh Goebel and Carl Baxtercalc(2px+3px) (#2241)New languages: none.
New styles: none.
Improvements:
New languages: none.
New styles:
Improvements:
!~ method definition (#2222)@dynamicMemberLookup and @propertyWrapper (#2202)endWithParent inside starts now always works (#2201)vbscript as potential script tag subLanguagefuture built-in (#1610)New languages: none. New styles: none. Improvements:
script tags (#1690)Improvements:
New languages: none. New styles: none. Improvements:
New languages: none. New styles: none. Improvements:
New languages: none. New styles: none. Improvements:
New languages: none. New styles: none. Improvements: 🔥 Hot fix: updated build tool.
New languages: none. New styles: none. Improvements: 🔥 Hot fix: reverted hljs cli build tool, as it was causing issues with install.
New languages: none. New styles: none. Improvements: 🔥 Hot fix: reverted hljs cli build tool, as it was causing issues with install.
New languages: none. New styles: none. Improvements: 🔥 Hot fix that was preventing highlight.js from installing.
New languages: none.
New styles: none.
Improvements:
iso in class definitions, and function heads without bodies in traits and interfaces. Removed FUNCTION and CLASS modes until they are found to be needed and to provide some of the fixes.New languages: none.
New styles: none.
Improvements:
hljs - allows easier building from command line.New languages: none. New styles: none. Improvements:
New languages: none. New styles: none. Improvements:
New languages: none. New styles: none. Improvements:
annotation and verbatim keywords to Crystal, by Benoit de ChezellesC# as an alias for CSharp language, by Ahmed AtitoImprovements:
autoDetection to accept language aliases.New languages:
New styles:
Improvements:
endSameAsBegin for nested constructs with variable names
by Egor Rogov.@objcMembers to @attributes, by Berk ÇebidisableAutodetect for preventing autodetection by Egor RogovNew language:
New style:
Improvements:
[Attributes].New languages:
Improvements:
or, and and not keywords to C++.Apologies for missing the previous release cycle. Some thing just can’t be automated… Anyway, we’re back!
New languages:
Improvements:
<< in C++ defines.New languages
Improvements:
This version is the second one that deserved a name. Because I’m in New York, and the release isn’t missing the deadline only because it’s still Tuesday on West Coast.
New languages:
Improvements:
A comprehensive bugfix release. This is one of the best things about highlight.js: even boring things keep getting better (even if slow).
=> functions, highlighted object attributes and
parsing within template string substitution blocks (${...}).<tag/> in JSX.HEALTHCHECK directive in Docker.<...>.New languages:
New styles:
Plus, a few smaller updates for Lasso, Elixir, C++ and SQL.
New languages:
New styles:
Notable changes:
New languages:
New styles:
Improvements to existing languages and styles:
$this is highlighted as a keyword in PHP.usize and isize are now highlighted in Rust.New languages:
New styles:
Improvements to existing languages and styles:
move to Rust keywordsNew languages:
New styles:
Improvements to existing languages and styles:
(lambda) in Scheme is no longer highlighted as a function
call.macro_rules! is now recognized as a built-in in Rust.New languages:
New Styles:
Improvements to existing languages and styles:
struct as a class-level definition in RustThe new major version brings a reworked styling system. Highlight.js now defines a limited set of highlightable classes giving a consistent result across all the styles and languages. You can read a more detailed explanation and background in the tracking issue that started this long process back in May.
This change is backwards incompatible for those who uses highlight.js with a custom stylesheet. The new style guide explains how to write styles in this new world.
Bundled themes have also suffered a significant amount of improvements and may look different in places, but all the things now consistent and make more sense. Among others, the Default style has got a refresh and will probably be tweaked some more in next releases. Please do give your feedback in our issue tracker.
New languages in this release:
Improvements to existing languages and styles:
Other notable changes:
Some last-minute changes reverted due to strange bug with minified browser build:
New languages:
Notable fixes and improvements to existing languages:
abstract and namespace keywords to TypeScript by Daniel Rosenwasserlabel support to Dockerfile by Ladislav PrskavecOther notable changes:
New languages:
Notable fixes and improvements to existing languages:
async and await to PythonOther notable changes:
New languages:
New styles:
Notable fixes and improvements to existing languages:
New languages:
New styles:
Notable fixes and improvements to existing languages:
async keyword from ES6/7 is now supportedNew languages:
New styles:
Notable fixes and improvements to existing languages:
def foo, do: ... now work in Elixir.<script> tag now allows any language, not just JavaScript.We’ve got the new demo page! The obvious new feature is the new look, but apart from that it’s got smarter: by presenting languages in groups it avoids running 10000 highlighting attempts after first load which was slowing it down and giving bad overall impression. It is now also being generated from test code snippets so the authors of new languages don’t have to update both tests and the demo page with the same thing.
Other notable changes:
template_comment class is gone in favor of the more general comment.New languages:
We streamlined our tool chain, it is now based entirely on node.js instead of being a mix of node.js, Python and Java. The build script options and arguments remained the same, and we’ve noted all the changes in the documentation. Apart from reducing complexity, the new build script is also faster from not having to start Java machine repeatedly. The credits for the work go to Jeremy Hull.
Some notable fixes:
throw keyword is no longer detected as a method name in Java.New languages in this release:
We’ve finally got real tests and continuous testing on Travis thanks to Jeremy Hull and Chris Eidhof. The tests designed to cover everything: language detection, correct parsing of individual language features and various special cases. This is a very important change that gives us confidence in extending language definitions and refactoring library core.
We’re going to redesign the old demo/test suite into an interactive demo web app. If you’re confident front-end developer or designer and want to help us with it, drop a comment into the issue on GitHub.
As usually there’s a handful of new languages in this release:
Other improvements:
New languages:
New styles:
Other improvements:
listLanguages() method in the API.lang- prefix for language names in HTML classes supported
alongside language-. Thanks to Jeff Escalante.This new major release is quite a big overhaul bringing both new features and some backwards incompatible changes. However, chances are that the majority of users won’t be affected by the latter: the basic scenario described in the README is left intact.
Here’s what did change in an incompatible way:
We’re now prefixing all classes located in CSS classes reference with
hljs-, by default, because some class names would collide with other
people’s stylesheets. If you were using an older version, you might still want
the previous behavior, but still want to upgrade. To suppress this new
behavior, you would initialize like so:
<script type="text/javascript">
hljs.configure({classPrefix: ''});
hljs.initHighlightingOnLoad();
</script>
This is useful for auxiliary modes needed only in one place to define parsing. Note that such modes often don’t have className and hence won’t generate a separate <span> in the resulting markup. This is similar in effect to noMarkup: true. All existing languages have been refactored accordingly.
Test file test.html has at last become a real test. Now it not only puts the detected language name under the code snippet but also tests if it matches the expected one. Test summary is displayed right above all language snippets.
Fine people at Yandex agreed to host highlight.js on their big fast servers. Link up!
Though I’m on a vacation in Paris, I decided to release a new version with a couple of small fixes:
A long-awaited version is finally released.
New languages:
Fixes for existing languages:
The highlighter has become more usable as a library allowing to do highlighting from initialization code of JS frameworks and in ajax methods (see. readme.eng.txt).
Also this version drops support for the WordPress plugin. Everyone is welcome to pick up its maintenance if needed.
<pre> tags to avoid conflicts with host site styles.Fixed escaping of quotes in VBScript strings.
This version brings a small change: now .ini-files allow digits, underscores and square brackets in key names.
Fixed small but upsetting bug in the packer which caused incorrect highlighting of explicitly specified languages. Thanks to Andrew Fedorov for precise diagnostics!
The version to fulfil old promises.
The most significant change is that highlight.js now preserves custom user markup in code along with its own highlighting markup. This means that now it’s possible to use, say, links in code. Thanks to Vladimir Dolzhenko for the initial proposal and for making a proof-of-concept patch.
Also in this version:
This is one of those nice version consisting entirely of new and shiny contributions!
The main change in the new major version of highlight.js is a mechanism for packing several languages along with the library itself into a single compressed file. Now sites using several languages will load considerably faster because the library won’t dynamically include additional files while loading.
Also this version fixes a long-standing bug with Javascript highlighting that couldn’t distinguish between regular expressions and division operations.
And as usually there were a couple of minor correctness fixes.
Great thanks to all contributors! Keep using highlight.js.
This version comes with two contributions from Jason Diamond:
Plus there are a couple of minor bug fixes for parsing HTML and XML attributes.
The biggest news is highlighting for Lisp, courtesy of Vasily Polovnyov. It’s somewhat experimental meaning that for highlighting “keywords” it doesn’t use any pre-defined set of a Lisp dialect. Instead it tries to highlight first word in parentheses wherever it makes sense. I’d like to ask people programming in Lisp to confirm if it’s a good idea and send feedback to the forum.
Other changes:
<pre> and <code><% .. %>)Languages:
Styles:
In other news. One small bug was fixed, built-in keywords were added for Python and C++ which improved auto-detection for the latter (it was shame that my wife’s blog had issues with it from time to time). And lastly thanks go to Sam for getting rid of my stylistic comments in code that were getting in the way of JSMin.
New major version is a result of vast refactoring and of many contributions.
Visible new features:
Invisible new features:
Changing of a major version number caused by a new format of language definition files. If you use some third-party language files they should be updated.
A very nice version in my opinion fixing a number of small bugs and slightly increased speed in a couple of corner cases. Thanks to everybody who reports bugs in he forum and by email!
There is also a new language — XML. A custom XML formerly was detected as HTML and didn’t highlight custom tags. In this version I tried to make custom XML to be detected and highlighted by its own rules. Which by the way include such things as CDATA sections and processing instructions (<? ... ?>).
Vladimir Gubarkov has provided an interesting and useful addition. File export.html contains a little program that shows and allows to copy and paste an HTML code generated by the highlighter for any code snippet. This can be useful in situations when one can’t use the script itself on a site.
Many thanks to you all!
Three new languages are available: Django templates, SQL and Axapta. The latter two are sent by Dmitri Roudakov. However I’ve almost entirely rewrote an SQL definition but I’d never started it be it from the ground up :-)
The engine itself has got a long awaited feature of grouping keywords (“keyword”, “built-in function”, “literal”). No more hacks!
It is major mainly because now highlight.js has grown large and has become modular. Now when you pass it a list of languages to highlight it will dynamically load into a browser only those languages.
Also:
There is also a small backwards incompatible change in the new version. The function initHighlighting that was used to initialize highlighting instead of initHighlightingOnLoad a long time ago no longer works. If you by chance still use it — replace it with the new one.
Highlight.js is a parser, not just a couple of regular expressions. That said I’m glad to announce that in the new version 2.9 has support for:
#{...}A maintenance release with more tuned heuristics. Fully backwards compatible.
Fixed bugs were rather unpleasant so I encourage everyone to upgrade!
Also highlight.js homepage now lists sites that use the library. Feel free to add your site by dropping me a message until I find the time to build a submit form.
This version fixes IE breakage in previous version. My apologies to all who have already downloaded that one!
Version 1.0 of javascript syntax highlighter is released!
It’s the first version available with English description. Feel free to post your comments and question to highlight.js forum. And don’t be afraid if you find there some fancy Cyrillic letters – it’s for Russian users too :-)