path: root/ikiwiki/directive/format.mdwn
diff options
Diffstat (limited to 'ikiwiki/directive/format.mdwn')
1 files changed, 29 insertions, 0 deletions
diff --git a/ikiwiki/directive/format.mdwn b/ikiwiki/directive/format.mdwn
new file mode 100644
index 0000000..7d11d22
--- /dev/null
+++ b/ikiwiki/directive/format.mdwn
@@ -0,0 +1,29 @@
+The `format` directive is supplied by the [[!iki plugins/format desc=format]]
+The directive allows formatting a chunk of text using any available page
+format. It takes two parameters. First is the type of format to use,
+ie the extension that would be used for a standalone file of this type.
+Second is the text to format.
+For example, this will embed an otl outline inside a page using mdwn or
+some other format:
+ \[[!format otl """
+ foo
+ 1
+ 2
+ bar
+ 3
+ 4
+ """]]
+Note that if the highlight plugin is enabled, this directive can also be
+used to display syntax highlighted code. Many languages and formats are
+supported. For example:
+ \[[!format perl """
+ print "hello, world\n";
+ """]]
+[[!meta robots="noindex, follow"]]