Syntax Highlighting Examples

A collection of syntax highlighting examples for Highlight’s natively supported languages.

Table of Contents

• Folder Contents
• About the Examples
  • Examples Source Files
  • Examples Preview Document
  • Current Status

Folder Contents

End user contents:

• /ex-src/ — examples source files.
• Highlight_Examples.html — example preview document.
• styles.css — stylesheets for preview document.

Extra files and source material for maintainers:

• /_adoc/ — AsciiDoc sources to build preview document.
• /_sass/ — Sass sources to build .
• CONTRIBUTING.md — contributors guidelines.

About the Examples

The goal of this folder is to gather a source code example for every language natively supported by Highlight.

Examples Source Files

The examples source files are stored in the ex-src/ folder, so they can be easily accessed via Highlight GUI for testing themes:

• /ex-src/

Beside offering a quick preview of how a language can be colorized by Highlight, examples files should also serve the following purposes:

• Theme Design — Theme designers need test how a theme looks across various languages.
• Theme Picking — A web designer might need to choose a theme that looks nice with a particular language.

Examples Preview Document

A single HTML document containing all the highlighted examples and some extra info on the languages is also available:

• Highlight_Examples.html

Current Status

This sub-project is in its early stage, so only a few languages have an example at this moment. The ultimate goal is to provide an example for every supported language, so if you are fluent in any of the missing languages feel free to contribute your own example files.