diff options
Diffstat (limited to 'plugins/include_code.rb')
| -rw-r--r-- | plugins/include_code.rb | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/plugins/include_code.rb b/plugins/include_code.rb index e00f1c81..6a7d786e 100644 --- a/plugins/include_code.rb +++ b/plugins/include_code.rb @@ -5,13 +5,20 @@ # # Syntax {% include_code path/to/file %} # -# Example: +# Example 1: # {% include_code javascripts/test.js %} # # This will import test.js from source/downloads/code/javascripts/test.js # and output the contents in a syntax highlighted code block inside a figure, # with a figcaption listing the file name and download link # +# Example 2: +# You can also include an optional title for the <figcaption> +# +# {% include_code Example 2 javascripts/test.js %} +# +# will output a figcaption with the title: Example 2 (test.js) +# require 'pathname' |