X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/1fc3f034191d3eec78b4d5da343e282092a221be..97d921ca676d51279b9fdfbaa7501fc8ebf8a027:/doc/ikiwiki/directive/format.mdwn diff --git a/doc/ikiwiki/directive/format.mdwn b/doc/ikiwiki/directive/format.mdwn index 7d11d225f..ae976faed 100644 --- a/doc/ikiwiki/directive/format.mdwn +++ b/doc/ikiwiki/directive/format.mdwn @@ -18,7 +18,7 @@ some other format: 4 """]] -Note that if the highlight plugin is enabled, this directive can also be +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: @@ -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"]]