android.moparisthebest.org/source/docs/plugins/include-code/index.markdown
2011-08-21 16:31:10 -04:00

42 lines
1.3 KiB
Markdown

---
layout: page
title: "Include Code"
date: 2011-07-22 09:13
updated: 201-08-21 16:18
sidebar: false
footer: false
---
Import files on your filesystem into any blog post as embedded code snippets with syntax highlighting and a download link.
In the `_config.yml` you can set your `code_dir` but the default is `source/downloads/code`. Simply put a file anywhere under that directory and
use the following tag to embed it in a post.
#### Syntax
{{ "{% include_code [title] [lang:language] path/to/file" }} %}
#### Example 1
This includes a file from `source/downloads/code/test.js`.
{{ "{% include_code test.js" }} %}
{% include_code test.js %}
#### Example 2
By default the `<figcaption>` will be the filename, but you can add a title before the filepath if you like.
{{ "{% include_code Add to_fraction for floats ruby/test.rb" }} %}
This includes a file from `source/downloads/code/ruby/test.rb`.
{% include_code Add to_fraction for floats ruby/test.rb %}
#### Example 3 (Force Highlighting)
Pygments supports many languages, but doesn't recognize some file extensions.
Add `lang:your_language` to force highlighting if the filename doesn't work.
{{ "{% include_code test.coffee lang:coffeescript" }} %}
{% include_code test.coffee lang:coffeescript %}