From: https://launchpad.net/~eliasson <eliasson@web>
Date: Wed, 10 Feb 2016 10:14:25 +0000 (-0400)
Subject: Add usage example
X-Git-Tag: 3.20160506~85
X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/commitdiff_plain/7b7f6986b9e483a9195bf2d3515396182efb9d7d

Add usage example
---

diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn
index 04ed13959..ae976faed 100644
--- a/doc/ikiwiki/directive/format.mdwn
+++ b/doc/ikiwiki/directive/format.mdwn
@@ -26,4 +26,12 @@ supported. For example:
 	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"]]