improved documentation on codeblock plugin

This commit is contained in:
Brandon Mathis 2011-07-20 12:11:52 -04:00
parent c030550917
commit 0843c02f4e

View File

@ -2,11 +2,19 @@
# Author: Brandon Mathis http://brandonmathis.com # 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. # 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: # For syntax highlighting, put a file extension somewhere in the title. examples:
# {% codeblock file.sh %} # {% codeblock file.sh %}
# code snippet
# {% endcodeblock %}
#
# {% codeblock Time to be Awesome! (awesome.rb) %} # {% codeblock Time to be Awesome! (awesome.rb) %}
# code snippet
# {% endcodeblock %}
# #
# Example: # Example:
# #