1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-18 15:54:50 +00:00
TiddlyWiki5/plugins/tiddlywiki/highlight/readme.tid

82 lines
1.6 KiB
Plaintext
Raw Normal View History

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.
2015-09-11 18:53:06 +00:00
! 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
2015-09-11 18:53:06 +00:00
* bash
* cmake
2015-09-11 18:53:06 +00:00
* coffeescript
* cpp
* cs
* css
* diff
* dockerfile
* erlang
* elixir
* fortran
* go
* gradle
* haskell
* html
2015-09-11 18:53:06 +00:00
* http
* ini
* intel x86 assembly
2015-09-11 18:53:06 +00:00
* java
* javascript
* json
* kotlin
* less
* lua
2015-09-11 18:53:06 +00:00
* makefile
* markdown
* mathematica
* matlab
2015-09-11 18:53:06 +00:00
* nginx
* objectivec
* perl
* php
* plaintext
* powershell
* properties
2015-09-11 18:53:06 +00:00
* python
* R
2015-09-11 18:53:06 +00:00
* ruby
* rust
* scss
* shell session
2015-09-11 18:53:06 +00:00
* sql
* swift
* toml
* typescript
* vala
* vim script
2015-09-11 18:53:06 +00:00
* 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/`.