Syntax-highlighting Code Block (with Server-side Rendering)

Description

This plugin extends to Code block in WordPress core to add syntax highlighting which is rendered on the server. By performing the syntax highlighting on the server, there is then no need to enqueue any JavaScript on the frontend (e.g. Highlight.js or Prism.js) and this ensures there is no flash of unhighlighted code (FOUC?). Reducing script on the frontend improves frontend performance and it also allows for the syntax highlighted code to appear properly in AMP pages as rendered by the official AMP plugin (see also ampproject/amp-wp#972).

The extended Code block uses auto-detection for the language in the block to add syntax highlighting, but you can override the language in the block inspector. (There is currently no syntax highlighting of the Code block in the editor.) The plugin supports for all 185 programming languages that highlight.php supports (being a port of highlight.js).

Any one of 89 styles may be enqueued that highlight.php/highlight.js provide. To override the default style, use the syntax_highlighting_code_block_style to supply the one of the style names, for example github:

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

This plugin is developed on GitHub. 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.

Credits

This is a fork of Code Syntax Block by Marcus Kazmierczak (mkaz), which is also available on WordPress.org. Copyright (c) 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

Screenshots

  • Supply content as you do normally in the Code block, optionally overriding the auto-detected language.
  • The Code block renders with syntax highlighting on the frontend without any JavaScript enqueued.

Blocks

This plugin provides 1 block.

core/code

Reviews

August 1, 2019
Just installed this on my site and started writing up a new post. I can't get over how well it works. Thanks, Weston!
July 31, 2019
Thanks for publishing this plugin, Weston! I just installed it on my website and it works great. No configuration needed. My coding tutorials look so much better now 🙂
Read all 2 reviews

Contributors & Developers

“Syntax-highlighting Code Block (with Server-side Rendering)” is open source software. The following people have contributed to this plugin.

Contributors

“Syntax-highlighting Code Block (with Server-side Rendering)” has been translated into 3 locales. Thank you to the translators for their contributions.

Translate “Syntax-highlighting Code Block (with Server-side Rendering)” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

For the plugin’s changelog, please see the Releases page on GitHub.