tw-prism

This is a TiddlyWiki plugin for syntax highlight with PrismJS.

Demo: https://gera2ld.github.io/tw-prism/.

Why this?

There is an official tiddlywiki plugin for syntax highlight but it is based on an old version of highlight.js. It is not easy to update to a newer version or customize styles.

This plugin was created with automation in mind.

Dependencies like PrismJS are defined in package.json and can be easily updated to the latest version with the help of npm-check-updates. Supported languages and additional aliases are defined in scripts/build.mjs.

There is a dedicated tool for customization of this plugin. You can pick the languages you like and your favorite theme there.

Installation

See https://gera2ld.github.io/tw-prism/.

Building from source

You can edit definitions and rebuild the plugin by:

$ yarn build

The generated plugin can be found at dist/gera2ld/prism.

To visit the demo, open dist/data/output/index.html.

Local usage

# Link dist/gera2ld/prism to your plugins directory
$ mkdir -p plugins/gera2ld
$ ln -s /path/to/tw-prism/dist/gera2ld/prism plugins/gera2ld

# Start server with TIDDLYWIKI_PLUGIN_PATH
$ TIDDLYWIKI_PLUGIN_PATH=plugins tiddlywiki data