http://softwaremaniacs.org/wiki/ 2012-05-16T20:25:52-07:00 http://softwaremaniacs.org/wiki/ http://softwaremaniacs.org/wiki/lib/tpl/default/images/favicon.ico text/html 2012-04-27T14:34:42-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:api?rev=1335562482&do=diff Highilght.js exports a few functions as methods of the hljs object. highlight(language_name, value) Core highlighting function. Accepts a language name and a string with the code to highlight. Returns an object with the following properties: * language: language name, same as the one passed into a function, returned for consistency with highlightAuto * relevance: integer value * keyword_count integer value * value: HTML string with highlighting markup text/html 2012-02-16T09:34:53-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:contributor_checklist?rev=1329413693&do=diff 1. Put language definition into a .js file Its only job is to define new attribute hljs.LANGUAGE.some_language where “some_language” is a short language identifier suitable to be used as a class name in HTML and CSS. Common good practice is not to define any global variables and do all the work inside an anonymous function: text/html 2012-04-13T11:58:02-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:highlight.js?rev=1334343482&do=diff Note: These are developer resources on highlight.js. For usage documentation go to the highlight.js user site. * Language definition guide * Mode reference * Library API * Style definition guide * Contributor checklist * Testing highlight.js text/html 2012-04-09T02:02:40-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:language?rev=1333962160&do=diff Highlighting overview Programming language code consists of parts with different rules of parsing: keywords like for or if don't make sense inside strings, strings may contain backslash-escaped symbols like \” and comments usually don't contain anything interesting except the end of the comment. text/html 2012-04-13T11:26:19-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:line_numbers?rev=1334341579&do=diff Highlight.js' notable lack of line numbers support is not an oversight but a feature. Following is the explanation of this policy from the current project maintainer (hey guys!): " One of the defining design principles for highlight.js from the start was simplicity. Not the simplicity of code (in fact, it's quite complex) but the simplicity of usage and of the actual look of highlighted snippets on HTML pages. Many highlighters, in my opinion, are overdoing it with such things as separate colo… text/html 2012-04-23T23:08:01-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:mode_reference?rev=1335247681&do=diff Types Types of attributes values in this reference: identifier String suitable to be used as a Javascript variable and CSS class name (i.e. mostly /[A-Za-z0-9_]+/) regexp String representing a Javascript regexp. Note that since it's not a literal regexp all back-slashes should be repeated twice boolean Javascript boolean: true or false number Javascript number object Javascript object: { ... } array Javascript array: [ ... ] Attributes className type: identifier text/html 2011-06-20T09:21:23-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:style?rev=1308586883&do=diff Overview Highlighted code is a single <code> element containing <span>s with pre-defined classes. Its appearance is controlled by a normal CSS file that can use all the features of CSS. There are however a couple of specific requirements for highlight.js styles: text/html 2012-04-13T15:32:49-07:00 http://softwaremaniacs.org/wiki/doku.php/highlight.js:testing_highlight.js?rev=1334356369&do=diff Build highlight-pack.js * Make sure you have Python 2.4 or higher and Java installed * Decide which language files you want to include in the package. * From the root directory, run python build.py [flags] [langnames] * current flags: --help (help), --no-compression or -n for no compression * [langnames] e.g. xml ruby , etc (with spaces)