mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-18 06:00:29 +00:00
2e1ad771d6
Clean up for CodeblockWidget documentation.
35 lines
1.0 KiB
Plaintext
35 lines
1.0 KiB
Plaintext
caption: codeblock
|
|
created: 20151103160200000
|
|
modified: 20151103160200000
|
|
tags: Widgets
|
|
title: CodeBlockWidget
|
|
type: text/vnd.tiddlywiki
|
|
|
|
! Introduction
|
|
|
|
The ''codeblock'' widget renders text in `<pre>` and `<code>` blocks, causing it to be
|
|
displayed monospace. A language may optionally be specified using the
|
|
''language'' attribute, however syntax highlighting will only be used if the
|
|
[[Highlight Plugin]] is installed.
|
|
|
|
! Content and Attributes
|
|
|
|
The content of the `<$codeblock>` widget is ignored.
|
|
|
|
|!Attribute |!Description|
|
|
|code|Contents of the block to render as code|
|
|
|language|Programming language for syntax highlighting|
|
|
|
|
! Examples
|
|
|
|
Here is an example embedding the contents of a tiddler as a code block.
|
|
|
|
<$macrocall $name='wikitext-example-without-html'
|
|
src='<$codeblock code={{$:/editions/tw5.com/macro-examples/say-hi}} />' />
|
|
|
|
A codeblock may also specify a language.
|
|
|
|
<$macrocall $name='wikitext-example-without-html'
|
|
src='<$codeblock code="SELECT * FROM users WHERE deleted = false" language="sql" />' />
|
|
|