1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-11 18:50:28 +00:00
TiddlyWiki5/plugins/tiddlywiki/highlight/readme.tid
cdruan 4f42df8bef
Update highlight.js to v11.4.0 (#6427)
* Rename v9 highlight.js plugin to highlight-legacy

* Add ES6 version of highlight.js plugin

* highlightblock.js

	- ensure this ES6 plugin will not cause error on legacy browsers
	- update the code to use new highlight.js APIs
	- change class tagging to match more closely with highlight.js
	- allow users to add language definitions as JS "highlight" modules

* styles.tid

	- update to match v11

* howto.tid

	- add instructions on how to add language definitions as JS modules

* highlight.min.js, default.min.css

	- version 11.4.0 common languages only

* Remove extraneous whitespaces

* Update readme.tid

* Update bundled languages

bundled: common + apache + nginx + latex + dockerfile + fortran

* Update highlight-legacy subtiddlers' titles

* Touch up highlight-legacy docs

* Touch up highlight plugin docs

* Fix pre block styling

- add "hljs" class to <pre> so the element can be styled
2022-02-21 15:35:13 +00:00

53 lines
1.2 KiB
Plaintext

title: $:/plugins/tiddlywiki/highlight/readme
\define highlightVersion() 11.4.0
This plugin provides syntax highlighting of code blocks using version <<highlightVersion>> of [[highlight.js|https://github.com/isagalaev/highlight.js]] from Ivan Sagalaev. This plugin does not work on browsers that do not fully support ~JavaScript ES6 (2015). If you need highlight.js running on those legacy browsers, you would need to install the "Highlight (Legacy)" plugin instead. Here's a [[ES6 compatibility table|https://caniuse.com/?search=es6]].
! Built-in Language Brushes
The plugin includes support for the following common languages (referred to as "brushes" by highlight.js):
* bash
* c
* cpp
* csharp
* css
* diff
* go
* html, xml
* java
* javascript
* json
* kotlin
* less
* lua
* makefile
* markdown
* objectivec
* perl
* php
* plaintext
* python
* R
* ruby
* rust
* scss
* sql
* shell session
* swift
* toml, ini
* typescript
* visual basic .net
* yaml
And these additional ones:
* apache config
* dockerfile
* fortran
* latex
* nginx config
The mapping between a MIME type and a highlight.js language specifier is accomplished via mapping tiddlers whose titles start with `$:/config/HighlightPlugin/TypeMappings/`.