Style guide
Instead of trying to make a rich set of highlightable classes look good in ahandful of languages we have a limited set of classes that work for alllanguages.
Hence, there are two important implications:
- Highlight.js styles tend to be minimalistic.
- It’s not possible to exactly emulate themes from other highlighting engines.
A theme is a single CSS defining styles for class names listed in theclass reference. The general guideline is tostyle all available classes, however an author may deliberately choose toexclude some (for example, is usually left unstyled).
Use as few or as many unique style combinations as you want.
Don’t use:
- specific font faces
font size, line height and anything that affects position and size ofcharacters within the container
Okay to use:- image backgrounds
These may seem arbitrary at first but it’s what has shown to make sense inpractice.
There’s also a common set of rules that has to be defined for the rootcontainer verbatim:
One important caveat: don’t forget to style . It’s used for parsedsections within strings and almost always should be reset to the default color:
You should include a comment at the top of the CSS file with attribution andother meta data if necessary. The format is free:
Send your contribution as a pull request on GitHub.