bb4a58fc699d70e0377434a0d8a60af3b34ffede
[ikiwiki.git] / doc / plugins / contrib / ikiwiki / directive / ymlfront.mdwn
1 The `ymlfront` directive is supplied by the [[!iki plugins/contrib/ymlfront desc=ymlfront]] plugin.
2
3 This directive allows the user to define arbitrary meta-data in YAML format.
4
5     \[[!ymlfront data="""
6      foo: fooness
7      bar: The Royal Pigeon
8      baz: 2
9      """]]
10
11 There is one argument to this directive.
12
13 * **data:**
14   The YAML-format data.  This should be enclosed inside triple-quotes to preserve the data correctly.
15
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 "---" ymlfront format with the directive form of the data.