X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8e92468eae9ac0ab8161a0c71ff6c6a0a8aef07a..036a9481b2422eba07f57e6773ddff71606866ee:/doc/ikiwiki/directive/format.mdwn?ds=sidebyside

diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn
index 94cf1b04f..ae976faed 100644
--- a/doc/ikiwiki/directive/format.mdwn
+++ b/doc/ikiwiki/directive/format.mdwn
@@ -18,4 +18,20 @@ some other format:
 		4
 	"""]]
 
+Note that if the [[!iki plugins/highlight desc=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";
+	"""]]
+
+`format` can also be used to format entire source files and display them on a page. Simply put an [[inline]] directive with the `raw` attribute set inside a `format`. This can be useful if you want to both serve the file raw, as well as show it syntax highlighted on a page. An example:
+
+	\[[!format python """
+	[[!inline pages="program.py" raw="yes"]]
+	"""]]
+
+	\[[View raw file|program.py]]
+
 [[!meta robots="noindex, follow"]]