WP-Markdown-SyntaxHighlighter is intended to work with the
wp-markdown and
SyntaxHighlighter Evolved plugins as follows:
- WP-Markdown can automatically use Prettify.js to format code, but if you prefer Alex Gorbatchev's SyntaxHighlighter, this plugin will re-format the Markdown-formatted code blocks to be properly styled by SyntaxHighlighter directly or SyntaxHighlighter Evolved via plugin.
- SyntaxHighlighter Evolved uses SyntaxHighlighter and additional extended functionality to display code blocks in an easily readable manner.
There are two methods of use:
- Add a
#! line to your code example and specify the language (brush) only
- Add a
#!! line to your code example and specify any/all supported parameters via a JSON object
Simple Method
To use, add a
#! line as the first line of your code example with the language you are using:
!ruby
class Foo < Bar
def hello
puts "Hello World!"
end
end
The
#! is removed, and the code is reformatted as:
class One < Two
def hello
puts "Hello World!"
end
end
Full Method
To use, add a
#!! line as the first line of your code example, with any of the supported SyntaxHighlighter parameters as a JSON object
!!{"brush":"ruby","toolbar":"true","highlight":"[2,3,4]"}
class Foo < Bar
def hello
puts "Hello World!"
end
end
The
#!! is removed, and the parameters are interpreted into a CSS class string as:
class Foo < Bar
def hello
puts "Hello World!"
end
end