mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-27 03:57:21 +00:00
28b861451b
Now we check that the selected language is supported before we invoke highlight.js; left to its own devices, it crashes… |
||
|---|---|---|
| .. | ||
| files | ||
| highlightblock.js | ||
| license.tid | ||
| plugin.info | ||
| readme.tid | ||
| styles.tid | ||
| TypeMappings.multids | ||
| usage.tid | ||
title: $:/plugins/tiddlywiki/highlight/readme
This plugin provides syntax highlighting of code blocks using v8.8.0 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
* bash
* coffeescript
* cpp
* cs
* css
* diff
* http
* ini
* java
* javascript
* json
* makefile
* markdown
* nginx
* objectivec
* perl
* php
* python
* ruby
* sql
* xml
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/`.