A WordPress plugin which extends Gutenberg adding *server-side* color syntax highlighting to the code block.
Clone or download
Pull request Compare This branch is 21 commits ahead, 44 commits behind mkaz:master.
Latest commit 3df16d2 Dec 19, 2018

readme.md

Server-Side Code Syntax Highlighting Block

A WordPress plugin which extends Gutenberg by adding server-side syntax highlighting to the WordPress core code block. Fully compatible with the offical AMP plugin.

Example:

screen shot

Usage

Install code-syntax-block plugin to your WordPress plugins directory and activate. You can download a ZIP from the GitHub, without any build step required. You can also run npm run zip to create a ZIP of the non-development files.

This plugin upgrades the existing Code block in core. It uses auto-detection for the language in the block to add syntad highlighting, but you can override the language in the block inspector.

On the front-end when the post is being viewed, the code will be color syntax highlighted. Syntax highighting is performed server-side via highlight.php, so there is no JavaScript required on the frontend (e.g. Prism.js). Because of this, AMP pages get the same syntax highlighting as non-AMP pages.

Customize

The default install uses a limited set of languages from highlight.php (bash, cpp, css, diff, go, javascript, json, markdown, php, python, sql, xml). If your language is not included, you can modify the [.gitignore] to skip ignoring them and then optionally add a label in the get_languages() PHP function.

For styling, the default color theme is used from highlight.php. To use a different color scheme, you can use the code_syntax_block_style filter to use another one of the styles:

add_filter(
	'code_syntax_block_style',
	function() {
		return 'github';
	}
);

Colophon

Contribute

See list of current issues with the plugin. Please feel free to file any additional issues or requests that you may come across. Pull requests are welcome to help extend.

License

Copyright © 2018 Weston Ruter.
Forked from mkaz/code-syntax-block, copyright © 2018 Marcus Kazmierczak.
Licensed under GPL 2.0 or later.

highlight.php is released under the BSD 3-Clause License.
Copyright © 2006-2013, Ivan Sagalaev (maniac@softwaremaniacs.org ), highlight.js (original author).
Copyright © 2013, Geert Bergman (geert@scrivo.nl), highlight.php