Skip to content

Reference

phil/highlight
TypeKindRole
Phil\Highlight\Highlighterfinal readonly classThe languages by name and alias; tokens, HTML, and highlight() for code renderers
Phil\Highlight\LanguageinterfaceA tokenizer: name, aliases, tokens
Phil\Highlight\Tokenfinal readonly classA piece of the source and its type
Phil\Highlight\TokenTypeenumWhat a token is; its HTML class
Phil\Highlight\HtmlFormatterfinal classTokens as escaped HTML spans, at once or line by line
Phil\Highlight\LineOptionsfinal readonly classHow a block is written line by line: numbers, highlighted lines, annotations
Phil\Highlight\LineRangesfinal readonly classLines of a block, single and in ranges, read from 1,3-5
Phil\Highlight\LineMarkenumWhat a line is marked as; its HTML class
Phil\Highlight\Language\Codefinal readonly classThe tokenizer of a programming language described by a Syntax
Phil\Highlight\Language\Syntaxfinal readonly classWhat a programming language looks like to Code
Phil\Highlight\Language\Quotefinal readonly classA kind of quoted text
Phil\Highlight\Language\Definitionsfinal classThe syntaxes shipped
Phil\Highlight\Language\Markupfinal readonly classHTML and XML, with embedded languages
Phil\Highlight\Language\StyleSheetfinal readonly classCSS and SCSS
Phil\Highlight\Language\Yamlfinal readonly classYAML
Phil\Highlight\Language\Inifinal readonly classINI and its kin
Phil\Highlight\Language\Dockerfilefinal readonly classDockerfiles, arguments read by a shell language
Phil\Highlight\Language\Difffinal readonly classDiffs and patches
Phil\Highlight\Language\Markdownfinal readonly classMarkdown
Phil\Highlight\Language\Twigfinal readonly classTwig, with markup and expression languages
Phil\Highlight\Language\Phpfinal readonly classPHP, code and markup mixed
Phil\Highlight\Scanner\Cursorfinal class, internalA position in a source, read byte by byte
Phil\Highlight\Scanner\Outputfinal class, internalTokens joined by type
Phil\Highlight\Exception\HighlightExceptioninterfaceEvery exception of the library
Phil\Highlight\Exception\UnknownLanguagefinal classA language asked for by a name not known
Phil\Highlight\Exception\InvalidLanguagefinal classA language added under a name that cannot be asked for
Phil\Highlight\Exception\InvalidLineRangesfinal classLine ranges or a first line number that cannot be read

Files

PathRole
themes/light.css, themes/dark.css, themes/auto.cssThe themes of the hl- classes