Module: Reacco

Extended by:
Reacco
Included in:
Reacco
Defined in:
lib/reacco.rb,
lib/reacco/readme.rb,
lib/reacco/version.rb,
lib/reacco/extractor.rb,
lib/reacco/generator.rb,
lib/reacco/filters/toc.rb,
lib/reacco/filters/brief.rb,
lib/reacco/filters/hgroup.rb,
lib/reacco/extractor/block.rb,
lib/reacco/filters/prelang.rb,
lib/reacco/filters/literate.rb,
lib/reacco/filters/sections.rb,
lib/reacco/filters/headingid.rb

Overview

Reacco::Extractor::Block [class] An extractor block.

Defined Under Namespace

Modules: Filters Classes: Extractor, Generator, Readme

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.versionObject



2
3
4
# File 'lib/reacco/version.rb', line 2

def self.version
  "0.0.3"
end

Instance Method Details

#markdownObject

### markdown [class method] Returns the Redcarpet Markdown processor. This is an instance of ‘Redcarpet` with all the right options plugged in.

Reacco.markdown
#=> #<Redcarpet::Markdown ...>


31
32
33
34
# File 'lib/reacco.rb', line 31

def markdown
  Redcarpet::Markdown.new(Redcarpet::Render::HTML,
    :fenced_code_blocks => true)
end

#root(*a) ⇒ Object

### root [class method] Returns the root path of the Reacco gem. You may pass additional parameters.

Reacco.root
#=> '/usr/local/ruby/gems/reacco-0.0.1'


20
21
22
# File 'lib/reacco.rb', line 20

def root(*a)
  File.join File.expand_path('../../', __FILE__), *a
end