aboutsummaryrefslogtreecommitdiff
path: root/plugins/code_block.rb
diff options
context:
space:
mode:
authorBrandon Mathis <brandon@imathis.com>2011-07-20 12:11:52 -0400
committerBrandon Mathis <brandon@imathis.com>2011-07-20 12:13:27 -0400
commit0843c02f4ea3a2cd8a6e95bdc08cda5e11eea193 (patch)
treef077b1d0da31bb7b4852ca31af70845d7d713de2 /plugins/code_block.rb
parentc030550917da803e064aaaf00f556f6f11307c46 (diff)
downloadmy_new_personal_website-0843c02f4ea3a2cd8a6e95bdc08cda5e11eea193.tar.xz
my_new_personal_website-0843c02f4ea3a2cd8a6e95bdc08cda5e11eea193.zip
improved documentation on codeblock plugin
Diffstat (limited to 'plugins/code_block.rb')
-rw-r--r--plugins/code_block.rb10
1 files changed, 9 insertions, 1 deletions
diff --git a/plugins/code_block.rb b/plugins/code_block.rb
index 8c308f21..4264d197 100644
--- a/plugins/code_block.rb
+++ b/plugins/code_block.rb
@@ -2,11 +2,19 @@
# Author: Brandon Mathis http://brandonmathis.com
# Description: Write codeblocks with semantic HTML5 <figure> and <figcaption> elements and optional syntax highlighting — all with a simple, intuitive interface.
#
-# Syntax: {% codeblock [title] [url] [link text] %}
+# Syntax:
+# {% codeblock [title] [url] [link text] %}
+# code snippet
+# {% endcodeblock %}
#
# For syntax highlighting, put a file extension somewhere in the title. examples:
# {% codeblock file.sh %}
+# code snippet
+# {% endcodeblock %}
+#
# {% codeblock Time to be Awesome! (awesome.rb) %}
+# code snippet
+# {% endcodeblock %}
#
# Example:
#