The WordPress plugin
PHP
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/Prism/Detached
templates
vendor
Prism_Detached.php
README.md
README.txt
screenshot-1.png
screenshot-2.png
screenshot-3.png
screenshot-4.png
screenshot-5.png

README.md

Prism Detached

You can find it in the official WordPress Plugin Directory or install it directly via the plugins menu in the WordPress admin area.

Integrates the Prism Syntax Highlighting Library in WordPress.

Usage

First you should download and activate the plugin.

The basic procedure is:

  1. Create a custom field and paste the code into it.
  2. Insert the [prism ...] shorttag in your code, where you want the code block to appear.

Shorttag

[prism key=".." language=".." line=".." line_offset=".." post=".."]
  • key: the name of the custom field, which contains the code (required)
  • language: the language to highlight
  • line: highlighted lines (for syntax, check the offical docs)
  • line_offset: the offset, with which the line numbering should start
  • post: if you want to include a code piece of another post, you can explicitly specify the post id here

Cached Assets loader

The plugin includes (from v1.3 on) a cached assets loader, so that all needed assets are concatenated into one js and one css file to minimize the HTTP requests. To make use of the cached assets loader, just create a directory /cache/ inside your plugin directory and make it writable for PHP.

Supported languages

Only the ones from the official PrismJS Git repository

  • bash (Bash Unix Shell)
  • c
  • clike
  • coffeescript
  • cpp (C++)
  • css
  • groovy
  • java
  • javascript
  • markup (like: xHTML, MathML, SVG, LaTeX, RSS, XML, OWL, etc.)
  • php
  • python
  • scss (Sassy CSS)
  • sql

Supported themes

Only the ones from the official PrismJS Git repository

  • Default
  • Dark
  • Funky
  • Okaida
  • Tomorrow
  • Twilight

Q&A

Why use custom tags?

The (rich text) editor of WordPress is quite good in mangling in manually added code. This cannot happen with custom fields. Also, I personally, think it is more user-friendly.

Will my code snippets be searchable with the common WordPress search?

No. Since the code snippets are not in the actual post content, but separately in the custom fields, the default WordPress search won't find them. You can make your custom fields searchable, though.

Can I add my own extensions?

Yes. Just read through the manual.

What will happen to my custom extensions, if I update the plugin using the WordPress plugin update function?

WordPress will remove them. WordPress completely removes the old extension directory and recreates it with the new plugin files. So make a backup of your custom extensions before updating!

Screenshots

Add the code as custom field and reference it in the rich text editor via shortcode.

Add the code as custom field and reference it in the rich text editor via shortcode.

Code highlighting in the frontend

Code highlighting in the frontend

You can also specify some lines, which should be marked

You can also specify some lines, which should be marked

Code highlighting with marked lines in the frontend

Code highlighting with marked lines in the frontend

Plugin options screen

Plugin options screen