This directory contains references to the colour palettes and schemes used for syntax highlighting in the ALAN Docs project.
Table of Contents
alan-tester.cifc— ColorImpact 4 palette project file for our test theme.alan-tester.txt— Colour specs for our test theme.palettes.cifc— ColorImpact 4 palettes collection project file.swatches_b16-eighties.png— HLJS GitHub palette swatches.swatches_b16-google-dark.png— Base16 Eighties palette swatches.swatches_github.png— Base16 Google Dark palette swatches.
Although the different Asciidoctor backends employ different syntax highlighters, which vary in the details of the syntax constructs they capture, the base colour palettes employed by their themes are the same, as well as their usage in the theme colour scheme (i.e. how each palette entry is applied to syntax elements).
For the ALAN syntax, we provide three different colour themes, to distinguish different types of ALAN code snippet, when the context requires it:
| theme | role/class | scheme | type |
|---|---|---|---|
| Default | none | tweaked HLJS GitHub | greyish neutral |
| Library | lib |
Base16 Eighties | dark theme |
| Tutorial | tutorial |
Base16 Google Dark | light theme |
The Default theme is used for generic examples, not linked to any external file. For its theme, we use a slightly adapted version of the GitHub theme from highlight.js, which was based on an old colour scheme used by GitHub in the past; it's a greyish neutral theme, leaning more toward the light side.
The Library theme is used to identify code excerpts from libraries and third party extensions. For its theme, we use the Base16 Eighties scheme by Chris Kempson, a dark theme.
The Tutorial theme is used to identify code belonging to a tutorial source being developed. For its theme, we use the Base16 Google Dark scheme by Seth Wright, where we use the base07 white colour as background, in order to produce a very light theme.
This palette contains duplicate colours, with entries base0C, base0D and base0F sharing the same colour value (#3971ED).
The ALAN Tester palette is used in a custom Rouge theme to visually test and inspect results of our ALAN IF lexer, and it's not used in production.
It's main goal is to highlight with a different colour each syntax element covered by the lexer, whereas in our production themes some elements are hidden from view by assigning them the default text colour, or the same colour as other elmeents.