Contents

# MarkdownHelper

## File Inclusion  <img src="https://raw.githubusercontent.com/BurdetteLamar/MarkdownHelper/master/images/include.png" width="50">

This markdown helper enables file inclusion in GitHub markdown.

(Actually this README file is built using the file inclusion.)

You can use it to merge external files into a markdown (</code>.md</code>) file.

The merged text can be highlighted in a code block:

@[ruby](include.rb)

or plain in a code block:

@[:code_block](include.rb)

or verbatim (which GitHub renders however it likes).

[Note:  RubyGems.org chooses to highlight both code blocks above.  Go figure.]

### Usage

#### Specify Include Files with Pragmas

@[verbatim](include.md)

An inclusion pragma has the form:

<code>@[</code>*treatment*<code>](</code>*relative_file_path*<code>)</code>

where:

* *treatment* (in square brackets) is one of the following:
  * Highlighting mode such as <code>[ruby]</code>, to include a highlighted code block.  This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
  * <code>[:code_block]</code>, to include a plain code block.
  * <code>[:verbatim]</code>, to include text verbatim (to be rendered as markdown).
* *relative_file_path* points to the file to be included.


#### Include the Files with <code>MarkdownHelper#include</code>

@[ruby](usage.rb)

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
markdown_helper-0.1.3	readme/README.template.md