TiddlyWiki5/plugins/tiddlywiki/highlight
oeyoews 00bd6f8ee8
Remove unnecessary prefix field for highlight plugin (#8048)
2024-03-09 15:45:38 +00:00
..
files Remove unnecessary prefix field for highlight plugin (#8048) 2024-03-09 15:45:38 +00:00
TypeMappings.multids Revamp markdown plugin (#6528) 2023-01-14 09:49:04 +00:00
highlightblock.js Update highlight.js to v11.4.0 (#6427) 2022-02-21 15:35:13 +00:00
license.tid in resp to https://github.com/Jermolene/TiddlyWiki5/pull/328#issuecomment-32131402 2014-01-12 21:48:03 +00:00
plugin.info Update highlight.js to v11.4.0 (#6427) 2022-02-21 15:35:13 +00:00
readme.tid Update highlight.js to v11.4.0 (#6427) 2022-02-21 15:35:13 +00:00
styles.tid Update highlight.js to v11.4.0 (#6427) 2022-02-21 15:35:13 +00:00
usage.tid Update highlight.js to v11.4.0 (#6427) 2022-02-21 15:35:13 +00:00

readme.tid

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/`.