GitHub - vrana/jush: JavaScript Syntax Highlighter

vrana / jush Public

Notifications You must be signed in to change notification settings
Fork 5
Star 25

JavaScript Syntax Highlighter

jush.sourceforge.net/

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 363 Commits
modules		modules
changes.txt		changes.txt
compile.php		compile.php
composer.json		composer.json
demo.html		demo.html
demo.js		demo.js
jquery.jush.js		jquery.jush.js
json.php		json.php
jush-api.js		jush-api.js
jush-help.wsf		jush-help.wsf
jush.css		jush.css
jush.js		jush.js
readme.html		readme.html
sql.html		sql.html
tests.html		tests.html
tests.js		tests.js
textarea.html		textarea.html

Repository files navigation

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>JUSH - JavaScript Syntax Highlighter</title>
<body>

<h1>JUSH - JavaScript Syntax Highlighter</h1>
<p>Highlights the full stack of PHP application starting with HTML, PHP, SQL and JavaScript code and ending with HTTP headers, <code>php.ini</code> settings or database variables.</p>
<ul>
<li><a href="demo.html">Demo</a></li>
<li><a href="sql.html">SQL highlighter for various databases</a></li>
<li><a href="tests.html">Tests</a></li>
<li><a href="http://jush.sourceforge.net/">Homepage</a></li>
</ul>

<h3>Features</h3>
<ul>
<li>Highlights and links documentation in spaghetti code like nothing else: <code class="jush">&lt;span style="font: small;"&gt;&lt;?php mysql_query("SELECT 1"); ?&gt;&lt;/span&gt;</code>.</li>
<li>Supported languages: everything related to PHP: HTML5, JS, CSS 3, SQL including variables (multiple dialects), <code>php.ini</code> directives, HTTP and e-mail headers, Apache config. Anything could be embedded into each other, e.g. <code class="language-php">header("Content-Type: text/html")</code> or <code class="language-css_pro">color: expression(parentNode.style.color)</code>.</li>
<li>Allows using HTML tags in source code (could be used for pointing out important parts): <code class="language-php">echo "This part is <b>important</b>."</code>. Produces overlapping HTML tags in this case though.</li>
<li>Performance is a priority.</li>
<li><code class="language-htm">&lt;textarea&gt;</code> <a href="textarea.html">syntax highlight</a>.</li>
</ul>

<h3>Installation instructions</h3>
<ol>
<li>Copy <a href="jush.css">jush.css</a> and <a href="jush.js">jush.js</a> into your directory.</li>
<li>Add following snippet before the <code class="jush">&lt;/body&gt;</code> tag in HTML file:
<pre><code class="jush">&lt;script type="text/javascript" src="jush.js"&gt;&lt;/script&gt;
&lt;script type="text/javascript"&gt;
jush.style('jush.css');
jush.highlight_tag('code');
&lt;/script&gt;
</code></pre>
All <code class="jush">&lt;code class="jush"&gt;</code> tags will be highlighted. Language is determined by the class name beginning with "jush-" (e.g. <code class="jush">&lt;code class="jush-js"&gt;</code>). Default language is <code>htm</code>. It is also possible to use <code class="jush">&lt;code class="language-*"&gt;</code>.
</li>
</ol>
<p>Alternativelly call <code class="jush-js">jush.highlight(language, text)</code> to syntax highlight single text.</p>

<h3>Command-line help reference</h3>
<p>It is also possible to use JUSH for opening the appropriate documentation in a browser. On Windows, it is possible to run:</p>
<pre>Syntax: WScript jush-help.wsf filename line column [tabsize] [word]
Example: WScript jush-help.wsf readme.html 2 2
</pre>
<p>The example should open a browser with documentation of the <code class="jush">&lt;html&gt;</code> tag which is at position 2:2 of this file.</p>

<script type="text/javascript" src="jush.js"></script>
<script type="text/javascript">
jush.style('jush.css');
jush.highlight_tag('code');
</script>