module MdTransformer

Module containing classes relating to parsing and using Markdown content similarly to a hash

Constants

VERSION: Current MdTransformer version

Public Class Methods

markdown(content) click to toggle source

Creates a new Markdown object from given content @param content [String] the markdown content @return [MdTransformer::Markdown] the new Markdown object

# File lib/md_transformer.rb, line 19
def markdown(content)
  Markdown.new(content)
end

Also aliased as: md

markdown_file(path) click to toggle source

Creates a new Markdown object from a file @param path [String] path to the markdown file to open @return [MdTransformer::Markdown] the new Markdown object

# File lib/md_transformer.rb, line 26
def markdown_file(path)
  Markdown.new(path, file: true)
end

Also aliased as: md_file

md(content)

Alias for: markdown

md_file(path)

Alias for: markdown_file