From bfd09133de10dfe06a8541b2c2b4fb1c177c461e Mon Sep 17 00:00:00 2001 From: dnebauer Date: Mon, 14 Jan 2019 19:02:58 +0930 Subject: [PATCH] Add howto for changing highlight languages (#3674) * Create howto.tid Howto explains customising the languages supported by the highlight plugin. This involves: * Using the highlight.js download page to get a zip archive containing the files for a highlight.js server which supports a set of languages selected by the user * Replacing the highlight plugin's `highlight.pack.js` file with the `highlight.pack.js` file from the downloaded archive * Update plugin.info Add howto. --- plugins/tiddlywiki/highlight/howto.tid | 10 ++++++++++ plugins/tiddlywiki/highlight/plugin.info | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 plugins/tiddlywiki/highlight/howto.tid diff --git a/plugins/tiddlywiki/highlight/howto.tid b/plugins/tiddlywiki/highlight/howto.tid new file mode 100644 index 000000000..e2b5a77c1 --- /dev/null +++ b/plugins/tiddlywiki/highlight/howto.tid @@ -0,0 +1,10 @@ +title: $:/plugins/tiddlywiki/highlight/howto + +! Supporting Additional Languages + +The [[highlight.js|https://github.com/highlightjs/highlight.js]] project supports many languages. Only a subset of these languages are supported by the plugin. It is possible for users to change the set of languages supported by the plugin by following these steps: + +# Go to the highlight.js project [[download page|https://highlightjs.org/download/]], select the language definitions to include, and press the Download button to download a zip archive containing customised support files for a highlight.js syntax highlighting server. +# Locate the `highlight.pack.js` file in the highlight plugin -- on a stock Debian 8 system running Tiddlywiki5 under node-js it is located at `/usr/local/lib/node_modules/tiddlywiki/plugins/tiddlywiki/highlight/files/highlight.pack.js`. +# Replace the plugin `highlight.pack.js` file located in step 2 with the one from the downloaded archive obtained in step 1. +# Restart the Tiddlywiki server. diff --git a/plugins/tiddlywiki/highlight/plugin.info b/plugins/tiddlywiki/highlight/plugin.info index 2621c7d5c..bcc1ffa69 100644 --- a/plugins/tiddlywiki/highlight/plugin.info +++ b/plugins/tiddlywiki/highlight/plugin.info @@ -3,5 +3,5 @@ "description": "Highlight.js: syntax highlighting", "author": "JoaoBolila", "core-version": ">=5.0.0", - "list": "readme usage license" + "list": "readme usage howto license" }