aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhttps://launchpad.net/~eliasson <eliasson@web>2016-02-10 06:14:25 -0400
committeradmin <admin@branchable.com>2016-02-10 06:14:25 -0400
commit7b7f6986b9e483a9195bf2d3515396182efb9d7d (patch)
treed349c3bc977c39f1bf45a012c18a7fc085e3e1e0
parent3b67e5d5676468c290cce750417ef5cb59c842c5 (diff)
downloadikiwiki-7b7f6986b9e483a9195bf2d3515396182efb9d7d.tar
ikiwiki-7b7f6986b9e483a9195bf2d3515396182efb9d7d.tar.gz
Add usage example
-rw-r--r--doc/ikiwiki/directive/format.mdwn8
1 files changed, 8 insertions, 0 deletions
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"]]