Add custom shortcode for gists

2 files changed, 24 insertions, 2 deletions

diff --git a/README.md b/README.md
index b106df6..532ca4a 100644
--- a/README.md
+++ b/README.md
@@ -3,12 +3,33 @@
 Liquorice is a small black and white theme for [Hugo](https://github.com/spf13/hugo) (a fast and modern static website engine).
 
 
-## CSS minification
+### Dependencies
 
-CSS minification is done using the node tool [clean-css](https://github.com/GoalSmashers/clean-css).
+Liquorice needs at least version 0.12 of Hugo, as it uses features such as partials.
+
+
+### Shortcodes
+
+Liquorice comes with these additional shortcodes:
+
+
+#### gist
+
+Include a Github gist using their JavaScript include.
+
+    {{% gist e572b28c9a0eef0b2763 %}}
+
+Where the first parameter is the gist id.
+
+
+### Building
+
+There is not much to build, but the theme CSS is minified using the node tool [clean-css](https://github.com/GoalSmashers/clean-css).
 
     cleancss -o static/css/liquorice.min.css static/css/liquorice.css
 
+*Any change in styles needs to result in a minification!*
+
 
 # License
 
diff --git a/layouts/shortcodes/gist.html b/layouts/shortcodes/gist.html
new file mode 100644
index 0000000..4084570
--- /dev/null
+++ b/layouts/shortcodes/gist.html
@@ -0,0 +1 @@
+<script src="https://gist.github.com/{{ index .Params 0 }}.js"></script>