gentelella/vendors/google-code-prettify/README.md

1.3 KiB

Google Code Prettify

Direct port of svn into git from http://google-code-prettify.googlecode.com/svn/trunk/

Install

via Bower

bower install google-code-prettify

or Yeoman

yeoman install google-code-prettify

Usage

The prettify script is AMD compatible and can be used modularly. Here is an example of it in an AMD module:

define(['jquery', 'prettify'], function($, prettify){
	var code = null;
	$('pre').addClass('prettyprint').each(function(idx, el){
			code = el.firstChild;
			code.innerHTML = prettify.prettyPrintOne(code.innerHTML);
		})
	);
});

This version of google-code-prettify defines an anonymous module, which is more flexible. To allow your AMD loader to find google-code-prettify with a more convenient name, map a path to it as follows:

// using RequireJS
require.config({
	prettify: 'bower_components/google-code-prettify/prettify'
});

// using curl.js
curl.config({
	prettify: 'bower_components/google-code-prettify/prettify'
});

Or it may just be used in a global context like the following:

(function(){
	$('pre').addClass('prettyprint');
	prettyPrint();
})();

More information can be found in the original README.html