Module: Gimli

Extended by:
OptiFlagSet
Defined in:
lib/gimli/setup.rb,
lib/gimli.rb,
lib/gimli/path.rb,
lib/gimli/config.rb,
lib/gimli/markup.rb,
lib/gimli/version.rb,
lib/gimli/converter.rb,
lib/gimli/markupfile.rb,
lib/gimli/markup/code.rb,
lib/gimli/wkhtmltopdf.rb,
lib/gimli/markup/renderer.rb,
lib/gimli/markup/code_block.rb,
lib/gimli/markup/yaml_frontmatter_remover.rb

Overview

Set up the flags available

Defined Under Namespace

Modules: Markup Classes: Config, Converter, MarkupFile, Path, Wkhtmltopdf

Constant Summary collapse

VERSION = 
"0.5.9"

Class Method Summary collapse

Class Method Details

.configure {|config| ... } ⇒ Object

Create a config object

Examples:

Example usage

config = Gimli.configure |config| do
  config.file = './test.md'
  config.output_dir = '/tmp'
  config.table_of_contents = true
end

Yields:

  • (config) 


22
23
24
25
26
 
# File 'lib/gimli.rb', line 22

def self.configure
  config = Config.new
  yield config
  config
end

.process!(config) ⇒ Object

Starts the processing of selected files



29
30
31
32
 
# File 'lib/gimli.rb', line 29

def self.process!(config)
  @files = Path.list_valid(config.file, config.recursive).map { |file| MarkupFile.new(file) }
  Converter.new(@files, config).convert!
end