use_case.md

Nest Inclusions

An included markdown file can itself include more files.

File To Be Included

includee.md:

Text for inclusion, and a nested inclusion.

@[:markdown](nested_includee.md)

File For Nested Inclusion

nested_includee.md:

Text for nested inclusion.

Includer File

includer.md:

File to do nested inclusion.

@[:markdown](includee.md)

Include Via markdown_helper

CLI

markdown_helper include --pristine includer.md included.md

(Option --pristine suppresses comment insertion.)

API

include.rb:

require 'markdown_helper'

# Option :pristine suppresses comment insertion.
markdown_helper = MarkdownHelper.new(:pristine => true)
markdown_helper.include('includer.md', 'included.md')

File with Inclusion

Here's the finished file with the inclusion and nested inclusion:

included.md:

File to do nested inclusion.

Text for inclusion, and a nested inclusion.

Text for nested inclusion.