EnlighterJS is a free, easy-to-use, syntax highlighting class developed for MooTools. It is based on the famous Lighter.js. Using it can be as simple as adding a single script and style to your website, choosing the elements you wish to highlight, and EnlighterJS takes care of the rest. It also supports Inline-Syntax-Highlighting as well as the automatic creation of tab-panes to display groups of code together (useful for multi-language examples - e.g. html+css+js) Take a look into the Documentation or view the Theme Demo
This is a minimalistic example how to highlight sourcecode with EnlighterJS. The working example (correct js+css paths) is available within the EnlighterJS package (Example1.html).
<head>
...
<!-- Include EnlighterJS Styles -->
<link rel="stylesheet" type="text/css" href="EnlighterJS.min.css" />
<!-- Include MooTools Framework -->
<script type="text/javascript" src="mootools-core-1.5.0-full-nocompat.js"></script>
<!-- Include EnlighterJS -->
<script type="text/javascript" src="EnlighterJS.min.js" ></script>
<!-- Initialize EnlighterJS -->
<meta name="EnlighterJS" content="Advanced javascript based syntax highlighting" data-indent="4" data-selector-block="pre" data-selector-inline="code.special" />
...
</head>
<body>
...
<!-- This code will be highlighted as Javascript !-->
<pre data-enlighter-language="js">
$('#loading-example-btn').click(function () {
var btn = $(this)
btn.button('loading')
$.ajax(...).always(function () {
btn.button('reset')
});
});
</pre>
...
<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, <code class="special">window.addEvent('domready', function(){});</code> labore et dolore magna aliquyam erat.</p>
</body>
The following Themes and Languages are included into the EnlighterJS standard package:
List of languages with their corresponding identifiers and supported aliases (wrapped into brackets behind the names)
Theme identifiers are always expressed as lowercase!
Download EnlighterJS and extract the files or use bower.
#SHELL bower install enlighterjs
Copy the prebuild files of the Build/ directory into a web-accessible directory of your choice.
Link to the EnlighterJS.min.js javascript file and the EnlighterJS.min.css stylesheet in the head section of your document after the MooTools file. The example below assumes you moved the files into your scripts folder under "js/" and your styles folder under "css/". The extension .min indicates that these files are already minified. These files are ready for productive use! If you want to start developing, you should consider to use the uncompressed versions for easier debugging!
Rendering options can be defined as global option (Metainit attributes or options object) or local option using the data-enlighter- attributes on each codeblock. It is recommended to use local options only if necessary (e.g. to define a language for each block).
The integration of EnlighterJS requires the following 3 steps: 1. Integrate MooTools.Core, EnlighterJS Script+Styles into your page 2. Prepare your source code elements on your page by adding a language identifier 3. "Initialize" EnlighterJS to highlight the code
Link to the EnlighterJS.yui.js javascript file and the EnlighterJS.yui.css stylesheet
<head> ... <!-- Include EnlighterJS Styles --> <link rel="stylesheet" type="text/css" href="css/EnlighterJS.yui.css" /> <!-- Include MooTools Framework --> <script type="text/javascript" src="js/mootools-core-1.5.0-full-nocompat.js"></script> <!-- Include EnlighterJS --> <script type="text/javascript" src="js/EnlighterJS.yui.js" ></script> ... </head>
Prepare your source code by giving the element (containing the code) an optional data-enlighter-language attribute with the language of the code. Notice: Instead of Lighter.js *fuel:flame' syntax combo within the css classname, EnlighterJS will use HTML5 data- attributes!
<!-- Syntax highlight using Javascript and default theme -->
<pre data-enlighter-language="js">var myClass = new Class({})</pre>
<!-- Syntax highlight using the Git Theme with default language-->
<pre data-enlighter-theme="git">php_info();</pre>
Finally, use the following JavaScript code examples inside of a 'domready' or 'onload' callback to create the highlighted elements - this process is called initialization. Be sure to check out the Options section to see the various options you can use. The Example pages have various examples you can use. Further informations as well as some advanced examples are available within the Initialization Section.
// Use the Init utility function to highlight all pre elements - this is the recommended way and required to use the Code-Group feature
EnlighterJS.Util.Init('pre', null, {
language: 'php',
theme: 'Classic'
});
Instead of initializing EnlighterJS manually, since version 1.1 it is possible to use a simple html-metatag (called EnlighterJS Metainit) to run Enlighter on your page (with basic config options).
<!-- Initialize EnlighterJS --> <meta name="EnlighterJS" content="Advanced javascript based syntax highlighting" data-language="php" data-theme="Enlighter" data-indent="2" />
Since version 1.8, it's possible to highlight special lines of code. Just add the attribute data-enlighter-highlight to your codeblock and provide a set of lines to mark (ranges supported).
<!-- just highlight line number 2 !-->
<pre data-enlighter-language="js" data-enlighter-highlight="2">
this.tokens = tokens || [];
options = this.options;
</pre>
<!-- highlight line 2,3,4 !-->
<pre data-enlighter-language="js" data-enlighter-highlight="2-4">
EnlighterJS.Util.Init('pre', null, {
indent : 2,
grouping: false
});
</pre>
Version 2.0 introduces some amazing features like Inline-Syntax-Highlighting. The Metainit tool performs this action automatically.
// Highlight all pre(block) + code(inline) tags and use Javascript as default language
EnlighterJS.Util.Init('pre', 'code', {
language: 'javascript'
});
In some cases it might be usefull to start the linnumber counting with another value than 1 (maybe an excerpt). In this case you can add the data-enlighter-lineoffset attribute to your codeblock.
<!-- start linenumber counting with line 15 !--> <pre data-enlighter-language="js" data-enlighter-lineoffset="15"> this.tokens = tokens || []; options = this.options; </pre>
Initialization means, that all elements (you wish to highlight) get selected and rendered by EnlighterJS. The original codeblock is set invisible and the rendered one is injected after. This task can be performed in two different ways:
Instead of initializing EnlighterJS by javascript, it's possible to use a simple html-metatag (called EnlighterJS Metainit) to run Enlighter on your page (with basic config options). This will be usefull if you only need a basic setup. Take a look into the examples Examples/Testcase.Metainit.html to see how it is working! Basically Metainit takes the given html attribute options and converts them into a options object. These options will be passed to the Enlighter.Util.Helper() utility function - for inline elements (InlineRenderer) identified by data-selector-inline as well as block elements (BlockRenderer) by data-selector-block. This will take all the work for you by adding a single line to the head section to use all the amazing EnlighterJS features like Inline-Syntax-Highlighting or CodeGroups!
Description: It enables block highlighting for all pre elements on the page as well as inline highlighting for all code elements. Javascript is set as default language used for highlighting. Each tab is replaced by four spaces to avoid rendering issues. Additionally the "raw code button" is enabled which allows the user to toggle between highlighted and unhighlighted code (e.g. to copy code).
<!-- Initialize EnlighterJS --> <meta name="EnlighterJS" content="Advanced javascript based syntax highlighting" data-indent="4" data-selector-block="pre" data-selector-inline="code" data-rawcodebutton="true" data-language="javascript" />
Following attributes are available (optional) and will be converted to the required options object to trigger EnlighterJS.Util.Helper. Take a look into the Metainit.js sources to see how it is working.
EnlighterJS provides 4 ways to get manually initialized:
Notice: You can pass any of the Global Options with each method. Every method will invoke the EnlighterJS constructor.
// get element by it's ID and activate highlighting using markdown as language
document.id('myCustomCode').enlight({
language: 'ruby',
indent: 2
});
// disable highlighting
document.id('myCustomCode').enlight(false);
// create a new EnlighterJS instance
var myEnlighter = new EnlighterJS(document.id('myCustomCode'), {
language: 'php',
showLinenumbers: false
});
// enable highlighting
myEnlighter.enlight(true);
// Highlight all code tags (inline code) and use Javascript as default language
EnlighterJS.Util.Helper(document.getElements('code'), {
language: 'javascript',
renderer: 'Inline'
});
// OPTION1 - Element style syntax - get element by it's ID
document.id('myJsCode').enlight(true);
// OPTION2 - Element style syntax - highlight all pre elements with the class *myPhp*
// an EnlighterJS instance is automatically created
document.getElements('pre.myPhp').enlight({language: php});
Customize EnlighterJS` appearance by using the following configuration options. Try to start with one of the Example pages!
The following options can be passed to the following methods to customize the rendering behaviour: * EnlighterJS(codeblockElement, options = {}, container = null) constructor * EnlighterJS.Util.Helper(elements, options = {}) utility function * EnlighterJS.Util.Init(blockSelector, inlineSelector, options= {}) utility function (recommended)
var options = {
language : 'javascript',
theme : 'Eclipse',
indent : 2,
forceTheme: false,
rawButton: false,
showLinenumbers: false,
renderer: 'Inline'
};
// Initialize EnlighterJS - use inline-highlighting only
EnlighterJS.Util.Init(null, 'code', options);
Some options need to be applied directly to the container elements which holds the code to highlight. These "local" options will override all global options which are set.
<pre data-enlighter-language="js" data-enlighter-linenumbers="false" data-enlighter-lineoffset="5"> ... </pre>
<p>
EnlighterJS also supports <code class="special" data-enlighter-language="js">alert('Inline Sourcecode highlighting');</code> (since version 2.0).
</p>
This example shows how to use code-groups. You can define a new code-group by adding a data-enlighter-group attribute to your code tags you want to group. The value is used as an internal identifier and is not shown anywhere (e.g. use numerical identifiers). The name/title of the tab is defined by a data-enlighter-title attribute. To use a corporate style within all code-blocks grouped together, the theme definition of the first code-block defined in your document (the group leader) is used as theme of the complete group - other theme definitions will be ignored. if no theme is specified, the default theme (defined in the options) will be used, which is recommended.
<!-- the following 3 code-blocks will be grouped togehter - the theme will be "enlighter" (global theme definition of the group-leader) !-->
<pre data-enlighter-language="js" data-enlighter-group="group0001" data-enlighter-title="Javascript">
this.tokens = tokens || [];
options = this.options;
</pre>
<!-- Theme definition will be ignored !-->
<pre data-enlighter-language="java" data-enlighter-theme="panic" data-enlighter-group="group0001" data-enlighter-title="pure Java">
import javax.swing.JOptionPane;
public class OddEven {
/**
* "input" is the number that the user gives to the computer
*/
private int input; // a whole number("int" means integer)
</pre>
<!-- Theme definition will be ignored !-->
<pre data-enlighter-language="php" data-enlighter-theme="twilight" data-enlighter-group="group0001" data-enlighter-title="PHP Script">
/** Test Snippet */
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
</pre>
The initialization of code-groups differs from the standard. You have to use the EnlighterJS.Util.Helper utility function (triggered by Metainit and EnlighterJS.Util.Init) - it does the complete initialization and grouping for you! * JS-Initialization Chain: EnlighterJS.Util.Init -> EnlighterJS.Util.Helper -> EnlighterJS * Metainit-Initialization Chain: EnlighterJS.Util.Metainit -> EnlighterJS.Util.Helper -> EnlighterJS
Finally, use the following JavaScript code inside of a domready or onload event to create the highlighted elements. Check out the options section to see the various options you can use.
Notice: grouping has to set to true when using the javascript based initialization
// highlight all pre tags; no inline-highlighting
EnlighterJS.Util.Init('pre', null, {
indent: 4,
language: 'js',
theme: 'enlighter',
grouping: true,
rawButton: true
});
The EnlighterJS project is using Apache ANT as build-system. UglifyJS2 and clean-css are used to minify the production-ready javascript and css files. To save bandwidth/traffic or include self-defined languages, you can easily customize your EnlighterJS build by editing the build.xml file (found in the root directory) and run Apache ANT (target build)
You can also use the web-based EnlighterJS Builder to generate your customized package without the need of ANT - everything is done for you server-site!
If you want to remove some of the default theme you can edit the include.themes property and modify the list of css source files. For Example: only include the modern themes
#XML <!-- Themes to include !--> <property name="include.themes" value="Enlighter Godzilla Beyond Classic MooTwo Eclipse Droide" />
Or Include only your custom themes (Note: they have to be located into Source/Themes/)
#XML <!-- Themes to include !--> <property name="include.themes" value="Custom1 Custom2" />
Removing/Adding languages is also easy as this - they are defined by the include.languages property. For Example: only include html+css+js syntax highlighting (be careful - html is an alias for XML!, you have to include Xml)
#XML <!-- Languages to include !--> <property name="include.languages" value="Css Javascript Xml" />
EnlighterJS is OpenSource and managed on GitHub - if you like, you're welcome to contribute! To simplify the release and quality control process, please follow these remarks:
All browsers supported by MooTools and with HTML5 capabilities for "data-" attributes are compatible with EnlighterJS. It's possible that it may work with earlier/other browsers.
EnlighterJS requires MooTools.Core/1.4 (no compat) - tested with: * Core/1.4.5 * Core/1.5.0 * Core/1.5.1
EnlighterJS is OpenSource and licensed under the Terms of The MIT License (X11). You're welcome to contribute!
A note on comments here: These comments are moderated. No comments will show up until they are approved. Comments that are not productive (i.e. inflammatory, rude, etc) will not be approved.
Found a bug in this plugin? Please report it this repository's Github Issues.
blog comments powered by Disqus