diff options
| author | Jonas Smedegaard <dr@jones.dk> | 2010-08-27 10:01:58 +0200 |
|---|---|---|
| committer | Jonas Smedegaard <dr@jones.dk> | 2010-08-27 10:01:58 +0200 |
| commit | f398ad035b973608d380c9939ea845d8e2a0cdc2 (patch) | |
| tree | 1ba1a0c94e375ab8ed609eaa57a542c6b87de5a8 /doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn | |
| parent | 958e5735c946263a111420fe47abe58782581e8c (diff) | |
| parent | 6d213a0c739d5b34357b01a616f99197eeba6ad9 (diff) | |
Merge branch 'master' of git://git.ikiwiki.info
Diffstat (limited to 'doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn')
| -rw-r--r-- | doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn b/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn new file mode 100644 index 000000000..bb4a58fc6 --- /dev/null +++ b/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn @@ -0,0 +1,17 @@ +The `ymlfront` directive is supplied by the [[!iki plugins/contrib/ymlfront desc=ymlfront]] plugin. + +This directive allows the user to define arbitrary meta-data in YAML format. + + \[[!ymlfront data=""" + foo: fooness + bar: The Royal Pigeon + baz: 2 + """]] + +There is one argument to this directive. + +* **data:** + The YAML-format data. This should be enclosed inside triple-quotes to preserve the data correctly. + +If more than one ymlfront directive is given per page, the result is undefined. +Likewise, it is inadvisable to try to mix the "---" ymlfront format with the directive form of the data. |