This is the official repository for the Flix language specification for highlight.js.
If you fork this repository there is a GitHub workflow that on each push will automatically build a minimal highlight.js file that only supports Flix for the web.
Additionally, it also generates a Flix spec that can be appended to an existing highlight.js file.
The GitHub workflow always targets the latest release of highlight.js
We refer you to the official documentation for 3rd party grammars for highlight.js (read Testing & Packaging sections).
There are pre-built CDN files that can just be dropped in to work with
an existing highlight.js script.
These can be found in the dist/ directory of this repository.
Note that the dist/highlight.min.js file is the file
built by the GitHub workflow in this repository and is a minimal
highlight.js build that only supports Flix.
This file is NOT part of the CDN pre-built files and should
hence not but used if you intend to use highlight.js conventionally.
The highlight.js file built by the GitHub workflow should work automatically when included on a website.
We use mdBook for doc.flix.dev which has some custom styling rules (see css files) This is to properly highlight string interpolation among other things.
| Selector | Description |
|---|---|
.hljs-subst |
Used for highlighting string interpolation |
.hljs-meta |
Used for highlighting annotations |