mattshelton

<p>WP-Markdown-SyntaxHighlighter is intended to work with the <a href="https://wordpress.org/extend/plugins/wp-markdown/" rel="ugc">wp-markdown</a> and <a href="http://www.viper007bond.com/wordpress-plugins/syntaxhighlighter/" rel="nofollow ugc">SyntaxHighlighter Evolved</a> plugins as follows:</p>
<ul>
<li>WP-Markdown can automatically use <a href="http://code.google.com/p/google-code-prettify/" rel="nofollow ugc">Prettify.js</a> to format code, but if you prefer <a href="http://alexgorbatchev.com/SyntaxHighlighter/" rel="nofollow ugc">Alex Gorbatchev’s SyntaxHighlighter</a>, this plugin will re-format the Markdown-formatted code blocks to be properly styled by SyntaxHighlighter directly or SyntaxHighlighter Evolved via plugin.</li>
<li>SyntaxHighlighter Evolved uses SyntaxHighlighter and additional extended functionality to display code blocks in an easily readable manner.</li>
</ul>
<p>There are two methods of use:</p>
<ol>
<li>Add a <code>#!</code> line to your code example and specify the language (brush) only</li>
<li>Add a <code>#!!</code> line to your code example and specify any/all supported parameters via a JSON object</li>
</ol>
<h4>Simple Method</h4>
<p>To use, add a <code>#!</code> line as the first line of your code example with the language you are using:</p>
<pre><code>#!ruby
class Foo < Bar
  def hello
    puts "Hello World!"
  end
end
</code></pre>
<p>The <code>#!</code> is removed, and the code is reformatted as:</p>
<pre><code><pre class="brush:ruby; notranslate" title="">class One < Two
  def hello
    puts "Hello World!"
  end
end</pre>
</code></pre>
<h4>Full Method</h4>
<p>To use, add a <code>#!!</code> line as the first line of your code example, with any of the supported SyntaxHighlighter parameters as a JSON object</p>
<pre><code>#!!{"brush":"ruby","toolbar":"true","highlight":"[2,3,4]"}
class Foo < Bar
  def hello
    puts "Hello World!"
  end
end
</code></pre>
<p>The <code>#!!</code> is removed, and the parameters are interpreted into a CSS class string as:</p>
<pre><code><pre class="brush: ruby; toolbar: true; highlight: [2,3,4]; notranslate">class Foo < Bar
  def hello
    puts "Hello World!"
  end
end</pre>
</code></pre>
<h3>TODO</h3>
<ul>
<li>Consider adding support to toggle ‘notranslate’</li>
</ul>


WP-Markdown-SyntaxHighlighter

WP-Markdown-SyntaxHighlighter works in conjunction with Markdown-formatted code blocks and SyntaxHighlighter to properly format code.

dwhitevisoft

<p>For years I’ve used <a href="http://alexgorbatchev.com/SyntaxHighlighter/" rel="nofollow ugc">Alex Gorbatchev’s SyntaxHighlighter</a>. It has served me well over the years. When I moved to WordPress I tried various plugins based on the library, such <a href="https://wordpress.org/extend/plugins/syntaxhighlighter/" rel="ugc">SyntaxHighlighter Evolved</a>.</p>
<p>I’ve decided to start blogging using <a href="http://daringfireball.net/projects/markdown/" rel="nofollow ugc">Markdown</a>. Making this move I needed to find a way to highlight various bits of source code in an easy way. There are many nice libraries that make this a snap, such as <a href="http://code.google.com/p/google-code-prettify/" rel="nofollow ugc">google-code-prettify</a> or <a href="http://softwaremaniacs.org/soft/highlight/en/" rel="nofollow ugc">highlight.js</a>. In the end I decided to go with highlight.js, for the simple reason that it is automatic, working flawlessly with Markdown’s code syntax output.</p>
<p>Great, but my existing source code examples use SyntaxHighlighter’s style for code blocks (using <code><pre class="brush: ruby;" /></code>, for example). I could have converted things in a few ways:</p>
<ul>
<li>Change the database</li>
<li>Write a JS script to convert the <code><pre /></code> structure to <code><pre><code /></pre></code></li>
<li>Write a JS script to call highlight.js’ <code>highlightBlock</code> method</li>
<li>Write a WP plugin and reformat things easily <strong>Ding Ding Ding</strong></li>
</ul>
<p>So there you have it. This WordPress plugin will go through and process your SyntaxHighlighter style blocks into ones that highlight.js works with out-of-the-box. It will also add the language that you have specified with the <code>brush</code> class and add it as a class on the <code><code /></code> element (<a href="http://www.w3.org/html/wg/drafts/html/master/text-level-semantics.html#the-code-element" rel="nofollow ugc">following the HTML5 recommendation</a>). Nothing is changed in the DB, so if you decide to go back to SyntaxHighlighter, you can without any issues.</p>
<h3>GeSHi</h3>
<p>This plugin now supports conversion of <a href="http://qbnz.com/highlighter/" rel="nofollow ugc">GeSHi</a> style code blocks! Now you can move from plugins such as <a href="https://wordpress.org/extend/plugins/wp-syntax/" rel="ugc">WP-Syntax</a> and <a href="https://wordpress.org/extend/plugins/wp-geshi-highlight" rel="ugc">WP-GeSHi-Highlight</a> to highlight.js.</p>
<p>GeSHi uses the syntax that is <em>close</em> to SyntaxHighlighter, except instead of putting the language in the <code>class</code> attribute, it uses the <code>lang</code> attribute. Similar to the SyntaxHighligher conversion, it will go through and process your GeSHi style blocks into ones that highlight.js works with out-of-the-box. It will also add the language that you have specified with the <code>lang</code> attribute and add it as a <code>class</code> on the <code><code /></code> element.</p>


Goodbye Syntax Highlighter

For years I've used Alex Gorbatchev's SyntaxHighlighter. It has served me well over the years. When I moved to WordPress I tried various plu …

WP-Markdown-SyntaxHighlighter vs Goodbye Syntax Highlighter