CAVEATS / POTENTIALLY BREAKING CHANGES
Core Grammars:
satisfies
operator Kisaragi Hiuor
conflicts with string highlighting Mohamed Aliself
variable [Lee Falin][]goto
to be recognized as a keyword in Java Alvin Joysudo
Alvin Joynew
keyword without capturing it within variables/class names Cameron Taylor_
separators, add hex p exponents Lisa Ugrayjustify-items
and justify-self
attributes Vasily Polovnyovaccent-color
, appearance
, color-scheme
, rotate
, scale
and translate
attributes Carl Räftingselect
, option
, optgroup
, picture
and source
to list of known tags Vasily Polovnyovinset
, inset-*
, border-start-*-radius
and border-end-*-radius
attributes Vasily Polovnyovtext-decoration-skip-ink
, text-decoration-thickness
and text-underline-offset
attributes Vasily PolovnyovNew Grammars:
Developer Tool:
highlight
API Misha KaletskyThemes:
1c-light
theme a like in the IDE 1C:Enterprise 8 (for 1c) Vitaly BarilkoCAVEATS / POTENTIALLY BREAKING CHANGES
node
build styles/*.css
files now ship un-minified
with minified counterparts as: styles/*.min.css
mvorisek
(this makes things consistent with our cdn
builds)Parser:
New Grammars:
Core Grammars:
if
while
for
[Omar Hussein][]x0-x30
and w0-w30
ARMv8 registers Nicholas Thompsonfinal
, is
, macro
keywords and $
identifiers Robert Borgheseabstract
declaration from keyword Robert Borghesemacro
keyword Bradley Mackey@unchecked
and @Sendable
support Bradley Mackey//> using foo bar
[Jamie Thompson][]!assert
compiler flag idlebergeprintln!
macro qoheniacwarn_unqualified_access
is an attribute Bradley Mackeyrecord
and var
as keywords Guillaume LaforgeDeveloper Tool:
highlight
API. Shah Shabbir AhmmedParser engine:
__emitTokens
key to grammars to allow then to direct their own parsing, only using Highlight.js for the HTML rendering Josh GoebelremovePlugin
api faga295JavaScript
Cyrus KaoNew Grammars:
Core Grammars:
_
in variable names [joshgoebel][]proto
alias for Protobuf [dimitropoulos][]base
, interface
, sealed
, and when
keywords Sam Rawlins->
operator legal) Keyacomselect
and until
as keywordsNew Grammars:
Grammars:
scm
alias for Scheme matyklug18<T =
are not JSX Josh Goebel((
keyword Nick Chambersimport()
as a function, rather a keyword nathnolt((
keyword Nick ChambersImprovements:
Supported Node.js versions:
Default build changes:
wasm
to default :common
build (#3526) Josh Goebelgraphql
to default :common
build (#3526) Josh GoebelGrammars:
keyword
to literal
shikhar13012001scoped
keyword in C# (#3571) David Pinetransparent
keyword Matt Bovel::
(#3540) Josh Goebelinclude_bytes!
macro (#3541) Serial-ATA==
as a variable declaration Mousetailany
keyword (#3515) Bradley Mackeydistributed
keyword Marcus Ortizmatch
and case
keywords Avrumy LungerThemes:
Tokyo-Night-dark
theme Henri VandersleyenTokyo-Night-light
theme Henri Vandersleyenpanda-syntax-dark
theme Annmarie Switzerpanda-syntax-light
theme Annmarie SwitzerNew Grammars:
Grammars:
type
and variable.language
scopes Josh Goebel$pattern
(numbers allowed in command names) Martin Mattelmeta.prompt
scope for REPL prompts, etc Josh Goebel***Hello world***
without breaking Josh Goebelelse
Josh GoebelNew Language:
Themes:
Default
is now much closer WCAG AA (contrast) (#3402) Josh GoebelDark
now meets WCAG AA (contrast) (#3402) Josh Goebelintellij-light
theme Pegasisfelipec
theme Felipe ContrerasThese changes should be for the better and should not be super noticeable but if you're super picky about your colors you may want to intervene here or copy over the older themes from 11.3 or prior.
Grammars:
vector<<
template false positive (#3437) Josh Goebelnamespace
and use
highlighting (#3427) Josh Goebel$this
is a variable.language
now (#3427) Josh Goebel__COMPILER_HALT_OFFSET__
(#3427) Josh Goebelsealed
and non-sealed
keywords (#3386) Bradley MackeyCLASS_REFERENCE
(#3411) Josh Goebel!
(#3417) idleberg!
(#3420) idlebergcomment
macro catches more than it should (#3395)$
in symbol breaks highlightingregex
mode to regex literalpunctuation
mode for commas.jldoctest
alias (#3432) Fons van der PlasDeveloper Tools:
Themes:
Build:
Build:
HighlightJS
named export (#3295) Josh Goebel.default
named export to CJS builds (#3333) Josh GoebelParser:
throwUnescapedHTML
to warn against potential HTML injection Josh Goebelregex
helper functions via hljs
injection Josh Goebel
Grammars:
class X extends Y
(#3278) Josh GoebelFloat32Array
highlighted incorrectly (#3353) Josh Goebelerror
type Josh GoebelSUBST
is no longer highlighted Josh Goebelxor_eq
keyword highlighting. Denis Kovalchukdo
and then
keyword (#3323) Nicolas Stuckienum
, export
and given
keywords (#3328) Nicolas Stuckiextension
soft keyword (#3326) Nicolas Stuckiend
soft keyword (#3327) Nicolas Stuckiinline
soft keyword (#3329) Nicolas Stuckiusing
soft keyword (#3330) Nicolas Stuckif#
alias (#3337) Bahnschriftcase_insensitive
to true
(#3351) idlebergBuild:
Parser:
_
(#3283) Josh Goebel__FILE__
and __LINE__
constants (#3283) Josh GoebelGrammars:
isolated
/nonisolated
keywords (#3296) Bradley MackeyNew Languages:
Grammars:
catch
keyword (#3251) Konrad Rudolphpwsh
alias (#3236) tebecoedn
alias (#3213) Stel AbregoThis is a major release. As such it contains breaking changes which may require action from users. Please read VERSION_11_UPGRADE.md for a detailed summary of all breaking changes.
Unless otherwise attributed items below are thanks to Josh Goebel (ref: #2558).
The below list should only be considered to be a high-level summary.
Deprecations / Removals / API Changes:
initHighlighting()
and initHighlightingOnLoad()
deprecated. Use highlightAll()
.highlightBlock(el)
deprecated. Use highlightElement(el)
before:highlightBlock
& after:highlightBlock
callbacks deprecated. Use equivalent highlightElement
callbacks.highlight(languageName, code, ignoreIllegals, continuation)
signature deprecated. Use highlight(code, {language, ignoreIllegals})
.highlight()
signature no longer supports continuation
argument.tabReplace
option removed. Consider a plugin.useBR
option removed. Consider a plugin or CSS.requireLanguage()
removed. Use getLanguage()
.endSameAsBegin
mode key removed. Use hljs.END_SAME_AS_BEGIN
.lexemes
mode key removed. Use keywords.$pattern
.Security:
Themes:
schoolbook
has been updated to remove the lined background.github
updated to better match modern GitHub (#1616) Jan Pilzergithub-gist
has been removed in favor of github
Jan Pilzernnfx
updated for v11 xml styles and improved css supportLanguage Grammars:
Parser:
beginScope
and endScope
to allow separate scoping begin and end (#3159) Josh GoebelendScope
now supports multi-class matchers as well (#3159) Josh GoebelhighlightElement
now always tags blocks with a consistent language-[name]
class Josh Goebel
span
tags now also always have the language-
prefix addedtitle.class.inherited
sub-scope support Josh Goebeltitle.class
sub-scope support (#3078) Josh Goebeltitle.function
sub-scope support (#3078) Josh GoebelbeforeMatch
compiler extension (#3078) Josh GoebelcssSelector
configuration option (#3180) James EdingtonGrammars:
.meta-keyword
=> .meta .keyword
(nested scopes) (#3167) Josh Goebel.meta-string
=> .meta .string
(nested scopes) (#3167) Josh Goebelactor
keyword (#3171) Bradley Mackey@resultBuilder
attribute (#3151) Bradley Mackeypde
alias (#3142) Dylan McBeanfunction.title
=> title.function
(#3078) Josh Goebelfunction.title
=> title.function
(#3078) Josh Goebelfunction.title
=> title.function
(#3078) Josh Goebelimpl
(#3078) Josh GoebelNew Languages:
Theme Improvements:
builtin-name
CSS class (#3119) Josh GoebelNew Themes:
Dev Improvements:
Parser:
unregisterLanguage
method (#3009) Antoine du HamelhighlightAll()
now works if the library is lazy loaded Josh GoebelNew Languages:
Language grammar improvements:
title.function
(#3169) Josh Goebeldefined?()
mis-highlighted as def
(#3025) Josh Goebel#include <str>
blocks (#3041) Josh Goebel#include <str>
blocks (#3041) Josh Goebeltrait
to class-like naming patterns (#2997) AyeshStringable
, UnhandledMatchError
, and WeakMap
classes/interfaces (#2997) Ayeshmixed
to list of keywords (#2997) Ayeshkts
as an alias for Kotlin (#3021) Vaibhav Chananafont-smoothing
to attributes list for CSS (#3027) AndyKIronprint
and exec
as a builtin (#1468) Samuel ColvinDeprecations:
highlight(languageName, code, ignoreIllegals, continuation)
deprecated as of 10.7
code
and then accepts options as an objecthighlight(code, {language, ignoreIllegals})
continuation
is for internal use only and no longer supportedhighlightBlock(el)
deprecated as of 10.7.
highlightElement(el)
instead.before/after:highlightBlock
=> before/after:highlightElement
el
vs block
attributeNew Languages:
Language grammar improvements:
Grammar Deprecations:
c-like
, though you should not be using it directly anyways.
c
and cpp
are now wholly unique grammars that will diverge over timeParser:
highlightAll()
API (#2962) Josh Goebel
initHighlighting()
and initHighlightingOnLoad()
beginKeyword
no longer bestows double relevance (#2953) Josh Goebelkeywords
to be an array of strings Josh Goebelmodes.MATCH_NOTHING_RE
that will never match
end
to hold a mode open (it must then be ended with endsParent
in one of it's children modes) Josh GoebelDeprecations:
initHighlighting()
and initHighlightingOnLoad()
deprecated.
highlightAll()
API instead.highlightAll
in v11.Build:
cdn-assets
Josh Goebel:common
) Josh GoebelParser:
match
as sugar for simple begin
only matches (#2834) Josh Goebelillegal
to also be an array of regex (#2834) Josh GoebelcompilerExtensions
allows grammers to influence mode compilation (#2834) Josh Goebel
New Languages:
Language grammar improvements:
make
as an alias (#2883) tripleee[]
for argument lists (#2913) Josh GoebelREM
comments and fixes '''
doctags (#2875) (#2851)Enable
, Disable
, and Then
keywordsRecent Deprecations:
<pre>
blocks will no longer be magically merged back into the
highlighted code's HTML result - it will instead be silently removed.tabReplace
option deprecated. (#2873) Josh Goebel
tab-size
property, or simply pre-process the
text yourself before rendering the initial HTMLuseBR
option deprecated. (#2559) Josh Goebel
<pre>
tagwhite-space: pre;
requireLanguage
API is deprecated, will be removed in v11.0.
getLanguage
(with custom error handling) or built-time dependencies.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 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>
tabReplace
and useBR
that were used in different places are also unified
into the global options object and are to be set using configure(options)
.
This function is documented in our API docs. Also note that these
parameters are gone from highlightBlock
and fixMarkup
which are now also
rely on configure
.
We removed public-facing (though undocumented) object hljs.LANGUAGES
which
was used to register languages with the library in favor of two new methods:
registerLanguage
and getLanguage
. Both are documented in our API docs.
Result returned from highlight
and highlightAuto
no longer contains two
separate attributes contributing to relevance score, relevance
and
keyword_count
. They are now unified in relevance
.
Another technically compatible change that nonetheless might need attention:
require('highlight.js')
works as before. This is contributed by Dmitry Smolin.New features:
Languages now can be recognized by multiple names like "js" for JavaScript or "html" for, well, HTML (which earlier insisted on calling it "xml"). These aliases can be specified in the class attribute of the code container in your HTML as well as in various API calls. For now there are only a few very common aliases but we'll expand it in the future. All of them are listed in the class reference.
Language detection can now be restricted to a subset of languages relevant in
a given context — a web page or even a single highlighting call. This is
especially useful for node.js build that includes all the known languages.
Another example is a StackOverflow-style site where users specify languages
as tags rather than in the markdown-formatted code snippets. This is
documented in the API reference (see methods highlightAuto
and
configure
).
Language definition syntax streamlined with variants and beginKeywords.
New languages and styles:
Miscellaneous improvements:
=>
prompts in Clojure.A catch-up release dealing with some of the accumulated contributions. This one is probably will be the last before the 8.0 which will be slightly backwards incompatible regarding some advanced use-cases.
One outstanding change in this version is the addition of 6 languages to the hosted script: Markdown, ObjectiveC, CoffeeScript, Apache, Nginx and Makefile. It now weighs about 6K more but we're going to keep it under 30K.
New languages:
Improvements:
?A
, ?1
, ?\012
etc. and %r{..}
regexps.(($filter "myCount") (arr 1 2 3 4 5))
.The latest long period of almost complete inactivity in the project coincided with growing interest to it led to a decision that now seems completely obvious: we need more core developers.
So without further ado let me welcome to the core team two long-time contributors: Jeremy Hull and Oleg Efimov.
Hope now we'll be able to work through stuff faster!
P.S. The historical commit is here for the record.
This long overdue version is a snapshot of the current source tree with all the changes that happened during the past year. Sorry for taking so long!
Along with the changes in code highlight.js has finally got its new home at http://highlightjs.org/, moving from its cradle on Software Maniacs which it outgrew a long time ago. Be sure to report any bugs about the site to info@highlightjs.org.
On to what's new…
New languages:
New style themes:
Other notable changes:
Since this version highlight.js no longer works in IE version 8 and older. It's made it possible to reduce the library size and dramatically improve code readability and made it easier to maintain. Time to go forward!
New languages: AppleScript (by Nathan Grigg and Dr. Drang) and Brainfuck (by Evgeny Stepanischev).
Improvements to existing languages:
>>>
and ...
)Also Oleg Efimov did a great job of moving all the docs for language and style developers and contributors from the old wiki under the source code in the "docs" directory. Now these docs are nicely presented at http://highlightjs.readthedocs.org/.
A regular bug-fix release without any significant new features. Enjoy!
A Summer crop:
The reason for the new major version update is a global change of keyword syntax which resulted in the library getting smaller once again. For example, the hosted build is 2K less than at the previous version while supporting two new languages.
Notable changes:
The library now works not only in a browser but also with node.js. It is
installable with npm install highlight.js
. API docs are available on our
wiki.
The new unique feature (apparently) among syntax highlighters is highlighting HTTP headers and an arbitrary language in the request body. The most useful languages here are XML and JSON both of which highlight.js does support. Here's the detailed post about the feature.
Two new style themes: a dark "south" Pojoaque by Jason Tate and an emulation ofXCode IDE by Angel Olloqui.
Three new languages: D by Aleksandar Ružičić, R by Joe Cheng and GLSL by Sergey Tikhomirov.
Nginx syntax has become a million times smaller and more universal thanks to remaking it in a more generic manner that doesn't require listing all the directives in the known universe.
Function titles are now highlighted in PHP.
Haskell and VHDL were significantly reworked to be more rich and correct by their respective maintainers Jeremy Hull and Igor Kalnitsky.
And last but not least, many bugs have been fixed around correctness and language detection.
Overall highlight.js currently supports 51 languages and 20 style themes.
A lot of things happened in highlight.js since the last version! We've got nine new contributors, the discussion group came alive, and the main branch on GitHub now counts more than 350 followers. Here are most significant results coming from all this activity:
5 (five!) new languages: Rust, ActionScript, CoffeeScript, MatLab and experimental support for markdown. Thanks go to Andrey Vlasovskikh, Alexander Myadzel, Dmytrii Nagirniak, Oleg Efimov, Denis Bardadym and John Crepezzi.
2 new style themes: Monokai by Luigi Maselli and stylistic imitation of another well-known highlighter Google Code Prettify by Aahan Krish.
A vast number of correctness fixes and code refactorings, mostly made by Oleg Efimov and Evgeny Stepanischev.
Jeremy Hull has implemented my dream feature — a port of Solarized style theme famous for being based on the intricate color theory to achieve correct contrast and color perception. It is now available for highlight.js in both variants — light and dark.
This version also adds a new original style Arta. Its author pumbur maintains a heavily modified fork of highlight.js on GitHub.
New major version of the highlighter has been built on a significantly refactored syntax. Due to this it's even smaller than the previous one while supporting more languages!
New languages are:
Also this version is marginally faster and fixes a number of small long-standing bugs.
Developer overview of the new language syntax is available in a blog post about recent beta release.
P.S. New version is not yet available on a Yandex CDN, so for now you have to download your own copy.
Fixed bugs in HTML/XML detection and relevance introduced in previous refactoring.
Also test.html now shows the second best result of language detection by relevance.
Past weekend began with a couple of simple additions for existing languages but ended up in a big code refactoring bringing along nice improvements for language developers.
This makes total number of languages supported by highlight.js to reach 35.
Bug fixes:
<pre>
tags are not being overridden anymore<pre>
containers:
highlighter now doesn't insist on replacing them with its own container and
just replaces the contents.The most significant change is the ability to include language submodes right
under contains
instead of defining explicit named submodes in the main array:
contains: [
'string',
'number',
{begin: '\\n', end: hljs.IMMEDIATE_RE}
]
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 :-)