Merge remote branch 'smcv/ready/transient-autoindex'
[ikiwiki.git] / doc / plugins / contrib / ikiwiki / directive / ymlfront.mdwn
blob1a01834f8e48d72588f5421ea4fd7516cc51746d
1 The `ymlfront` directive is supplied by the [[!iki plugins/contrib/ymlfront desc=ymlfront]] plugin.
3 This directive allows the user to define arbitrary meta-data in YAML format.
5     \[[!ymlfront data="""
6      foo: fooness
7      bar: The Royal Pigeon
8      baz: 2
9      """]]
11 There is one argument to this directive.
13 * **data:**
14   The YAML-format data.  This should be enclosed inside triple-quotes to preserve the data correctly.
16 If more than one ymlfront directive is given per page, the result is undefined.
17 Likewise, it is inadvisable to try to mix the non-directive ymlfront format with the directive form of the data.