summaryrefslogtreecommitdiff
path: root/doc/ikiwiki
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-10-31 16:42:20 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-10-31 16:42:20 -0400
commitbb841f94f47d865e4c78bd4f27c5f9cc04dc1557 (patch)
treed42775d3546e6213074bbd31f0fb3ebc322f654f /doc/ikiwiki
parent6ad8b8f7608d58a366b2813a397851f0c1c94411 (diff)
format: New plugin, allows embedding differntly formatted text inside a page (ie, otl inside a mdwn page, or syntax highlighted code inside a page).
Diffstat (limited to 'doc/ikiwiki')
-rw-r--r--doc/ikiwiki/directive/format.mdwn21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn
new file mode 100644
index 000000000..94cf1b04f
--- /dev/null
+++ b/doc/ikiwiki/directive/format.mdwn
@@ -0,0 +1,21 @@
+The `format` directive is supplied by the [[!iki plugins/format desc=format]]
+plugin.
+
+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
+ """]]
+
+[[!meta robots="noindex, follow"]]