Skip to content

markknol/html-haxe-code-highlighter

Repository files navigation

Simple Haxe Code Highlighter for HTML

Build Status Haxelib Version

Basic runtime Haxe code highlighting. Formerly used on haxe.org website.

Basic Installation

If you just want the highlighting, you can download and use the .js and .css files:

  1. Download <bin/highlighter.js> and add <script src="highlighter.js"></script> to your HTML.
  2. Download <bin/highlighter.min.css> and add <link rel="stylesheet" href="highlighter.min.css" /> to your HTML.

Installation using sources

If you want to integrate the highlighting in your project, install using Haxelib:

haxelib install html-haxe-code-highlighter

To use in code, add to your build hxml:

-lib html-haxe-code-highlighter

API

  • Highlighter.highlight(?container:js.html.Element) (JS target only) Adds highlighting to all <code class="prettyprint haxe"> and <code class="prettyprint hxml"> tags in the given element. If container is null, then document body element is used.

  • Highlighter.syntaxHighlightHaxe(code:String) Syntax highlight Haxe code. Returns code as formatted HTML text.

  • Highlighter.syntaxHighlightHXML(code:String) Syntax highlight HXML. Returns code as formatted HTML text.

CSS classes

The following css classes are applied

Description CSS class
Reserved keywords .kwd
Reserved values .val
Types .type
Strings .str
Regexp .ereg
Comments .cmt

Build with Haxe