TiddlyWiki5

mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-30 05:19:57 +00:00

History

Simon Huber e67485ec54 Highlight Plugin: Update readme to reflect version change (#4503 )		2020-03-14 17:16:38 +00:00
..
files	Update highlight.js to latest v9.18.1 (#4502 )	2020-03-14 13:06:50 +00:00
highlightblock.js	Add support of language aliases in highlight.js plugin (#3898 )	2019-04-15 18:45:45 +01:00
howto.tid	Add howto for changing highlight languages (#3674 )	2019-01-14 09:32:58 +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	Improve plugin metadata, and add a "name" field	2019-09-19 13:04:10 +01:00
readme.tid	Highlight Plugin: Update readme to reflect version change (#4503 )	2020-03-14 17:16:38 +00:00
styles.tid	Revert to a pale default theme for highlight plugin	2015-04-17 16:05:54 +01:00
TypeMappings.multids	Yet more tweaks to the highlight.js integration	2017-03-02 09:17:48 +00:00
usage.tid	Revert "Add text/vnd.tiddlywiki to system tiddlers within plugins that should be wikified (c.f. #2883 )"	2017-06-24 17:48:32 +01:00

readme.tid

title: $:/plugins/tiddlywiki/highlight/readme

This plugin provides syntax highlighting of code blocks using v9.18.1 of [[highlight.js|https://github.com/isagalaev/highlight.js]] from Ivan Sagalaev.

! Usage

When the plugin is installed it automatically applies highlighting to all codeblocks defined with triple backticks or with the CodeBlockWidget.

The language can optionally be specified after the opening triple braces:

<$codeblock code="""```css
 * { margin: 0; padding: 0; } /* micro reset */

html { font-size: 62.5%; }
body { font-size: 14px; font-size: 1.4rem; } /* =14px */
h1   { font-size: 24px; font-size: 2.4rem; } /* =24px */
```"""/>

If no language is specified highlight.js will attempt to automatically detect the language.

! Built-in Language Brushes

The plugin includes support for the following languages (referred to as "brushes" by highlight.js):

* apache
* arduino
* arm assembly
* asciidoc
* autohotkey
* awk
* bash
* cmake
* coffeescript
* cpp
* cs
* css
* diff
* dockerfile
* erlang
* elixir
* fortran
* go
* gradle
* haskell
* html
* http
* ini
* intel x86 assembly
* java
* javascript
* json
* kotlin
* less
* lua
* makefile
* markdown
* mathematica
* matlab
* nginx
* objectivec
* perl
* php
* plaintext
* powershell
* properties
* python
* R
* ruby
* rust
* scss
* shell session
* sql
* swift
* toml
* typescript
* vala
* vim script
* xml
* yaml

You can also specify the language as a MIME content type (eg `text/html` or `text/css`). The mapping is accomplished via mapping tiddlers whose titles start with `$:/config/HighlightPlugin/TypeMappings/`.