diff options
| author | Joey Hess <joey@kitenet.net> | 2010-08-09 13:19:17 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2010-08-09 13:19:17 -0400 |
| commit | 292e820974fd308148841b1714967619d4acba59 (patch) | |
| tree | 9bd6ccf58529b82dfe6c91c5148b647c33cc534b /doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn | |
| parent | 51d5e546974405741e08ed27d0bf89958fa7366b (diff) | |
| parent | d2b50c37b44972e60d08854e9e780a09481872d5 (diff) | |
Merge branch 'master' of ssh://git.ikiwiki.info/srv/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. |