Description
WP-Syntax-Highlighter is a WordPress plugin that brings the Highlight.js based source code syntax
highlighting to WordPress. This plugin is compatible with any other syntax highlighter
plugins that use Syntax Highlighter, GeSHi
or Prismjs.
Credits
- Thanks to Ivan Sagalaev and the highlight.js team for this excellent library.
Installation
- Click Plugins > Add New in the WordPress admin panel.
- Search for “wp-syntax-highlighter” and install.
Customization
The plugin comes bundled with all the themes provided by Highlight.js.
Use the Theme dropdown to change the selected theme.
Additionally the plugin checks for a custom.css
in your current
theme’s directory at {current_theme}/wp-syntax-highlighter/custom.css.
If this CSS file is present it will be added to the page automatically.
You can override any builtin theme’s styles in this manner.
To use a completely custom theme use the Custom option in Theme
dropdown. Now only your current theme’s custom.css will be used to style
the code blocks.
Shortcodes
Each language gets it’s own shortcode. You can use this to add code
blocks for that language into your posts.
For instance to add some PHP code into your post use,
[php]
foreach ($requirements as $requirement) {
$result = array(
'satisfied' => $requirement->check(),
'requirement' => $requirement
);
array_push($results, $result);
if (!$result['satisfied']) {
$success = false;
}
}
[/php]
Supported Languages
The following languages are currently supported by highlight.js.
- 1c
- Actionscript
- Apache
- Applescript
- Asciidoc
- Autohotkey
- Avrasm
- Axapta
- Bash
- Brainfuck
- Clojure
- Cmake
- Coffeescript
- Cpp
- CS
- CSS
- D
- Delphi
- Diff
- Django
- Dos
- Erlang
- Erlang-repl
- Fix
- Fsharp
- Glsl
- Go
- Haml
- Handlebars
- Haskell
- Http
- Ini
- Java
- Javascript
- JSON
- Lasso
- Lisp
- Livecodeserver
- Lua
- Makefile
- Markdown
- Mathematica
- Matlab
- Mel
- Mizar
- Nginx
- ObjectiveC
- Ocaml
- Oxygene
- Parser3
- Perl
- Php
- Profile
- Python
- R
- Rib
- Rsl
- Ruby
- Ruleslanguage
- Rust
- Scala
- Scilab
- SCSS
- Smalltalk
- SQL
- Tex
- Vala
- Vbnet
- Vbscript
- Vhdl
- XML
Note: Since WordPress shortcodes must be at least 2 characters long, for
language names shorter than 2 characters use the lang
suffix.
Eg:- [dlang][/dlang]
Compatibility with other Syntax Highlighters
The plugin is completely compatible with other syntax highlighters.
It does not change the content of your existing posts. You can safely go
back to use your previous syntax highlighter after trying out
wp-syntax-highlighter.
Both Syntax Highlighter and GeSHi
and supported by default. Prism based syntax highlighters will also
work out of the box as they utilize the same markup as Highlight.js.
FAQ
- Can I go back to my previous syntax highlighter plugin after using
this?
Yes. The code block scanning is done clientside by highlight.js. The
contents of your posts are only scanned to pick any embedded languages.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“wp-syntax-highlighter” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “wp-syntax-highlighter” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
0.5.1
- Upgrades to Arrow 1.8.0.
0.5.0
- Upgrades to Arrow 1.6.0.
- Updates Highlight.js to 8.1.
- Refreshes themes from Highlight.js repository.
- Cleaner build without development assets.
0.4.0
- Upgrades to Arrow 0.7.0
0.3.0
- Upgrades to Arrow 0.3.0.
0.2.2
- Fixes typos.
0.2.1
- Upgrades Arrow to 0.4.1.
0.2.0
- Switches to Arrow 0.4.0.
0.1.2
- First release on www.ads-software.com
0.1.0
- Initial Release