use_case.md

Include Highlighted Code

Use file inclusion to include text as highlighted code.

File to Be Included

Here's a file containing Ruby code to be included:

hello.rb:

class HelloWorld
   def initialize(name)
      @name = name.capitalize
   end
   def sayHi
      puts "Hello !"
   end
end

Includer File

Here's a template file that includes it:

includer.md:

This file includes the code as highlighted code.

@[ruby](hello.rb)

The treatment token ruby specifies that the included text is to be highlighted as Ruby code.

The treatment token can be any Ace mode mentioned in GitHub Languages. The file lists about 100 Ace modes, covering just about every language and format.

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 included highlighted code:

This file includes the code as highlighted code.

```hello.rb```:
```ruby
class HelloWorld
   def initialize(name)
      @name = name.capitalize
   end
   def sayHi
      puts "Hello !"
   end
end
```

And here's the finished markdown, as rendered on this page:

---

This file includes the code as highlighted code.

hello.rb:

class HelloWorld
   def initialize(name)
      @name = name.capitalize
   end
   def sayHi
      puts "Hello !"
   end
end

---