highlight.js - npm Package Compare versions

		@@ -10,2 +10,3 @@ Syntax highlighting with language autodetection.

		- Greg Allen <@jgaui>
		- Peter Leonov <gojpeg@gmail.com>
		@@ -12,0 +13,0 @@ - Victor Karamzin <Victor.Karamzin@enterra-inc.com>

package.json

		{
		"author": "Ivan Sagalaev, Greg Allen (@jgaui)",
		"name": "highlight.js",
		"description": "A node clone of highlight.js syntax highlighter library",
		"version": "1.0.3",
		"version": "1.0.4",
		"homepage": "https://github.com/jgallen23/highlight.js",
		"author": "Greg Allen <@jgaui> (http://jga.me)",
		"repository": {
		@@ -10,3 +11,7 @@ "type": "git",
		},
		"main": "src/highlight.full.js"
		"devDependencies": {
		"chai": "*",
		"mocha": "*"
		},
		"keywords": ["syntax", "highlighter"]
		}

144

README.md

		# Highlight.js

		Highlight.js highlights syntax in code examples on blogs, forums and,
		in fact, on any web page. It's very easy to use because it works
		automatically: finds blocks of code, detects a language, highlights it.
		Highlight.js is a node.js fork of [highlight.js](https://github.com/isagalaev/highlight.js) for the browser.

		Autodetection can be fine tuned when it fails by itself (see "Heuristics").
		##Install

		npm install highlight.js

		## Installation and usage
		##Usage

		The download package includes the file "highlight.pack.js" which is a full
		compressed version of the library intended for use in production. All
		uncompressed source files are also available, feel free to look into them!
		###Auto Language Detection:

		The script is installed by linking to a single file and making a single
		initialization call:
		var hl = require("highlight.js");
		var txt = "var test = 'asdf'";
		var html = hl.highlightAuto(txt);
		console.log(html.value);

		```html
		<script type="text/javascript" src="highlight.pack.js"></script>
		<script type="text/javascript">
		hljs.initHighlightingOnLoad();
		</script>
		```
		###Pass in Language:

		Also you can replace TAB ('\x09') characters used for indentation in your code
		with some fixed number of spaces or with a `<span>` to give them special
		styling:
		var hl = require("highlight.js");
		var txt = "var test = 'asdf'";
		var html = hl.highlight('javascript', txt);
		console.log(html.value);

		```html
		<script type="text/javascript">
		hljs.tabReplace = ' '; // 4 spaces
		// ... or
		hljs.tabReplace = '<span class="indent">\t</span>';
		##Example Output:

		hljs.initHighlightingOnLoad();
		</script>
		```

		The script looks in your page for fragments `<pre><code>...</code></pre>`
		that are traditionally used to mark up code examples. Their content is
		marked up by logical pieces with defined class names.


		### Custom initialization

		If you use different markup for code blocks you can initialize them manually
		with `highlightBlock(code, tabReplace)` function. It takes a DOM element
		containing the code to highlight and optionally a string with which to replace
		TAB characters.

		Initialization using, for example, jQuery might look like this:

		```javascript
		$(document).ready(function() {
		$('pre code').each(function(i, e) {hljs.highlightBlock(e, ' ')});
		});
		```

		If your code container relies on `<br>` tags instead of line breaks (i.e. if
		it's not `<pre>`) pass `true` into third parameter of `highlightBlock`:

		```javascript
		$('div.code').each(function(i, e) {hljs.highlightBlock(e, null, true)});
		```

		### Styling

		Elements of code marked up with classes can be styled as desired:

		```css
		.comment {
		color: gray;
		}

		.keyword {
		font-weight: bold;
		}

		.python .string {
		color: blue;
		}

		.html .atribute .value {
		color: green;
		}
		```

		Highlight.js comes with several style themes located in "styles" directory that
		can be used directly or as a base for your own experiments.

		Note: provided styles work for code defined inside `<pre>` blocks. If you use
		custom markup you should modify styles accordingly.

		For full reference list of classes see [classref.txt][cr].

		[cr]: http://github.com/isagalaev/highlight.js/blob/master/classref.txt


		## Export

		File export.html contains a little program that allows you to paste in a code
		snippet and then copy and paste the resulting HTML code generated by the
		highlighter. This is useful in situations when you can't use the script itself
		on a site.


		## Heuristics

		Autodetection of a code's language is done using a simple heuristic:
		the program tries to highlight a fragment with all available languages and
		counts all syntactic structures that it finds along the way. The language
		with greatest count wins.

		This means that in short fragments the probability of an error is high
		(and it really happens sometimes). In this cases you can set the fragment's
		language explicitly by assigning a class to the `<code>` element:

		```html
		<pre><code class="html">...</code></pre>
		```

		You can use class names recommended in HTML5: "language-html",
		"language-php". Classes also can be assigned to the `<pre>` element.

		To disable highlighting of a fragment altogether use "no-highlight" class:

		```html
		<pre><code class="no-highlight">...</code></pre>
		```

		## Meta

		- Version: 6.1
		- URL: http://softwaremaniacs.org/soft/highlight/en/
		- Author: Ivan Sagalaev (<maniac@softwaremaniacs.org>)

		For the license terms see LICENSE files.
		For the list of contributors see AUTHORS.en.txt file.
		<span class="keyword">var</span> test = <span class="string">'asdf'</span>

AUTHORS.ru.txt

README.ru.md

.gitignore

Sorry, the diff of this file is not supported yet

src/highlight.full.js

Sorry, the diff of this file is too big to display

Fixed alerts

Improved metrics

Worsened metrics