diff options
| author | http://kerravonsen.dreamwidth.org/ <http://kerravonsen.dreamwidth.org/@web> | 2010-08-06 08:13:48 +0000 |
|---|---|---|
| committer | Joey Hess <joey@finch.kitenet.net> | 2010-08-06 08:13:48 +0000 |
| commit | f78357348a028fe97037429f4712d511d2921b14 (patch) | |
| tree | d119189449cccc109bee5b0464a43b0fc207b002 /doc/plugins/contrib/ikiwiki/directive | |
| parent | 5bbbdbecbbe1e68b65baf35c3d8b8a371c9341b2 (diff) | |
ymlfront now provides a ymlfront directive
Diffstat (limited to 'doc/plugins/contrib/ikiwiki/directive')
| -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. |