improved documentation on codeblock plugin

imathis · imathis · commit 0843c02f4ea3 · 2011-07-20T12:13:27.000-04:00
diff --git 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:
 #

Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,19 @@`
`2`	`2`	`# Author: Brandon Mathis http://brandonmathis.com`
`3`	`3`	`# Description: Write codeblocks with semantic HTML5 <figure> and <figcaption> elements and optional syntax highlighting — all with a simple, intuitive interface.`
`4`	`4`	`#`
`5`		`-# Syntax: {% codeblock [title] [url] [link text] %}`
	`5`	`+# Syntax:`
	`6`	`+# {% codeblock [title] [url] [link text] %}`
	`7`	`+# code snippet`
	`8`	`+# {% endcodeblock %}`
`6`	`9`	`#`
`7`	`10`	`# For syntax highlighting, put a file extension somewhere in the title. examples:`
`8`	`11`	`# {% codeblock file.sh %}`
	`12`	`+# code snippet`
	`13`	`+# {% endcodeblock %}`
	`14`	`+#`
`9`	`15`	`# {% codeblock Time to be Awesome! (awesome.rb) %}`
	`16`	`+# code snippet`
	`17`	`+# {% endcodeblock %}`
`10`	`18`	`#`
`11`	`19`	`# Example:`
`12`	`20`	`#`