aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/cowsay.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/contrib/cowsay.mdwn')
-rw-r--r--doc/plugins/contrib/cowsay.mdwn33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/plugins/contrib/cowsay.mdwn b/doc/plugins/contrib/cowsay.mdwn
new file mode 100644
index 000000000..4d0824a04
--- /dev/null
+++ b/doc/plugins/contrib/cowsay.mdwn
@@ -0,0 +1,33 @@
+[[!template id=plugin name=cowsay author="[[BrianCandler]]"]]
+[[!tag type/fun]]
+
+This plugin provides the cowsay [[ikiwiki/directive]].
+This directive allows creation of ASCII-art cows.
+
+For example,
+
+~~~
+\[[!cowsay state="stoned" text="""
+moo tube!
+"""]]
+~~~
+
+renders as
+
+~~~
+ ___________
+< moo tube! >
+ -----------
+ \ ^__^
+ \ (**)\_______
+ (__)\ )\/\
+ U ||----w |
+ || ||
+~~~
+
+You must have the [cowsay](https://en.wikipedia.org/wiki/Cowsay) package
+installed.
+
+# Download
+
+You can get the source code from [github](https://github.com/candlerb/ikiwiki-cowsay)