Module: WikiWah

Defined in:
lib/wikiwah.rb,
lib/wikiwah/flow.rb,
lib/wikiwah/subst.rb,
lib/wikiwah/version.rb,
lib/wikiwah/converter.rb,
lib/wikiwah/tilt_integration.rb

Overview

A formatter for turning Wiki-esque text into HTML.

Block-level markup

  • A line prefixed by “=” is a heading. The heading-level is implied by the number of “=” characters.

  • A line beginning with “*” or “-” is an unordered list item.

  • A line beginning with “1.”, “(1)” or “#” is an ordered list item.

  • A paragraph prefixed by “|” is preformatted text (e.g. code)

  • A paragraph prefixed by “>” is a blockquote (ie. a citation)

Text markup

  • HTML tags are rendered verbatim.

  • Text may by marked bold, /italic/, underlined, monospace

  • Text may be quoted with ‘and ‘}}’

  • URLs turn into links.

  • “LOCATION” creates a link to LOCATION.

  • “LABEL@LOCATION” creates a link to LOCATION, with the specified LABEL.

Defined Under Namespace

Classes: Converter, Flow, Subst, Template

Constant Summary collapse

VERSION = 
"0.1.4".freeze

Class Method Summary collapse

Class Method Details

.convert(text) ⇒ Object 



36
37
38
 
# File 'lib/wikiwah.rb', line 36

def self.convert(text)
  Converter.new.convert(text)
end