mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00
Code Issues Releases Wiki Activity

Add howto for changing highlight languages (#3674)

Browse Source 
* 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.
This commit is contained in:
dnebauer 2019-01-14 19:02:58 +09:30 committed by Jeremy Ruston
parent 557053ab35
commit bfd09133de
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/tiddlywiki/highlight/howto.tid Normal file
View File

@ -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.

2
plugins/tiddlywiki/highlight/plugin.info
View File

@ -3,5 +3,5 @@
"description": "Highlight.js: syntax highlighting", "description": "Highlight.js: syntax highlighting",
"author": "JoaoBolila", "author": "JoaoBolila",
"core-version": ">=5.0.0", "core-version": ">=5.0.0",
"list": "readme usage license" "list": "readme usage howto license"
} }