Module: Markover

Defined in:

lib/markover.rb,
lib/markover/path.rb,
lib/markover/config.rb,
lib/markover/markup.rb,
lib/markover/version.rb,
lib/markover/converter.rb,
lib/markover/markupfile.rb,
lib/markover/markup/code.rb,
lib/markover/wkhtmltopdf.rb,
lib/markover/optionparser.rb,
lib/markover/markup/renderer.rb,
lib/markover/markup/code_block.rb,
lib/markover/markup/yaml_frontmatter_remover.rb

Defined Under Namespace

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

Constant Summary

VERSION =

"0.6.0"

Class Method Summary

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

  Create a config object.

• .process!(config) ⇒ Object

  Starts the processing of selected files.

Class Method Details

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

Create a config object

Examples:

Example usage

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

Yields:

• (config)

# File 'lib/markover.rb', line 21

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

.process!(config) ⇒ Object

Starts the processing of selected files

# File 'lib/markover.rb', line 28

def self.process!(config)
  Converter.new(config.files, config).convert!
end