]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/commitdiff
ymlfront now provides a ymlfront directive
authorhttp://kerravonsen.dreamwidth.org/ <http://kerravonsen.dreamwidth.org/@web>
Fri, 6 Aug 2010 08:13:48 +0000 (08:13 +0000)
committerJoey Hess <joey@finch.kitenet.net>
Fri, 6 Aug 2010 08:13:48 +0000 (08:13 +0000)
doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn [new file with mode: 0644]

diff --git a/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn b/doc/plugins/contrib/ikiwiki/directive/ymlfront.mdwn
new file mode 100644 (file)
index 0000000..bb4a58f
--- /dev/null
@@ -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.