WP Markdown Syntax Sugar work in conjunction with plugins such as wp-markdown
and wp-highlight.js. Markdown is fantastic markup for easily
writing blogs, and highlight.js is an extremely easy way to highlight
code examples. In most cases, highlight.js automatically detects the proper language for a block of code. In certain
cases, primarily if your code example is short, highlight.js could improperly detect the language that you are using;
that is where this plugin comes into play. By adding one line to your code blocks, you can explicitly set the language
that you are using, allowing highlight.js to properly format your code.
The concept is inspired by the wp-markdown-syntax-highlight
The usage is extremely simple. Just add a shebang 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 shebang is removed, and the code is outputted as:
<pre><code class="language-ruby">class Foo < Bar def hello puts "Hello World!" end end</code></pre>
Now the code block is properly formatted for highlight.js to do its magic, and the code snippet will be properly
Installation is standard and straight forward.
- Upload the
wp-markdown-syntax-sugarfolder (and all it’s contents) to the
- Activate the plugin through the ‘Plugins’ menu in WordPress
- Modify improperly formatted code blocks with a shebang.
Contributors & Developers
“WP-Markdown-Syntax-Sugar” is open source software. The following people have contributed to this plugin.Contributors
Interested in development?
- Initial release
- Modified output to use the HTML5 recommended syntax highlighting class names, e.g.
language-ruby. For more information, see the HTML5 spec