Class: BlueCloth

BlueCloth is a Ruby implementation of Markdown, a text-to-HTML conversion tool.

Classes
FormatError	Exception class for formatting errors.

Constants
AtxHeaderRegexp	Regexp for matching ATX-style headers
AutoAnchorEmailRegexp
AutoAnchorURLRegexp
BlockQuoteRegexp	Pattern for matching Markdown blockquote blocks
BoldRegexp	Pattern to match strong emphasis in Markdown text
CodeBlockRegexp	Pattern for matching codeblocks
CodeEscapeRegexp	Regexp to match special characters in a code block
EmptyElementSuffix	The tag-closing string — set to ’>’ for HTML
Encoders	Encoder functions to turn characters of an email address into encoded entities.
EscapeTable	Table of MD5 sums for escaped characters
HTMLCommentRegexp	Matching constructs for tokenizing X/HTML
HTMLTagCloseRegexp
HTMLTagOpenRegexp
HTMLTagPart
HruleBlockRegex	Special case for <hr />.
InlineImageRegexp	Next, handle inline images: ![alt text](url "optional title") Don’t forget: encode * and _
InlineLinkRegex
ItalicRegexp	Pattern to match normal emphasis in Markdown text
LinkRegex	Link defs are in the form: ^[id]: url "optional title"
ListItemRegexp	Pattern for transforming list items
ListMarkerAny
ListMarkerOl	Patterns to match and transform lists
ListMarkerUl
ListRegexp
LooseBlockRegex	More-liberal block-matching
LooseBlockTags
LooseTagPattern
MetaTag
PreChunk
RefLinkIdRegex	Pattern to match the linkid part of an anchor tag for reference-style links.
ReferenceImageRegexp	Reference-style images
RenderState	Rendering state struct. Keeps track of URLs, titles, and HTML blocks midway through a render. I prefer this to the globals of the Perl version because globals make me break out in hives. Or something.
SetextHeaderRegexp	Regex for matching Setext-style headers
StrictBlockRegex	Nested blocks:
StrictBlockTags	The list of tags which are considered block-level constructs and an alternation pattern suitable for use in regexps made from the list
StrictTagPattern
SvnId	SVN Id tag
SvnRev	SVN Revision
SvnUrl	SVN URL
TabWidth	Tab width for #detab! if none is specified
Version	Release Version
XMLProcInstRegexp

Public Attributes
filter_html	Filters for controlling what gets output for untrusted input. (But really, you’re filtering bad stuff out of untrusted input at submission-time via untainting, aren’t you?)
filter_styles	Filters for controlling what gets output for untrusted input. (But really, you’re filtering bad stuff out of untrusted input at submission-time via untainting, aren’t you?)
fold_lines	RedCloth-compatibility accessor. Line-folding is part of Markdown syntax, so this isn’t used by anything.

Public Methods
apply_block_transforms	Do block-level transforms on a copy of `str` using the specified render state `rs` and return the results.
apply_span_transforms	Apply Markdown span transforms to a copy of the specified `str` with the given render state `rs` and return it.
detab	Convert tabs in `str` to spaces.
detab!	Convert tabs to spaces in place and return self if any were converted.
encode_backslash_escapes	Return a copy of the given `str` with any backslashed special character in it replaced with MD5 placeholders.
encode_code	Escape any characters special to HTML and encode any characters special to Markdown in a copy of the given `str` and return it.
encode_email_address	Transform a copy of the given email `addr` into an escaped version safer for posting publicly.
encode_html	Return a copy of `str` with angle brackets and ampersands HTML-encoded.
escape_md	Escape any markdown characters in a copy of the given `str` and return it.
escape_special_chars	Escape special characters in the given `str`
form_paragraphs	Wrap all remaining paragraph-looking text in a copy of `str` inside <p> tags and return it.</p>
hide_html_blocks	Replace all blocks of HTML in `str` that start in the left margin with tokens.
new	Create a new BlueCloth string.
outdent	Return one level of line-leading tabs or spaces from a copy of `str` and return it.
strip_link_definitions	Strip link definitions from `str`, storing them in the given RenderState `rs`.
to_html	Render Markdown-formatted text in this string object as HTML and return it. The parameter is for compatibility with RedCloth, and is currently unused, though that may change in the future.
tokenize_html	Break the HTML source in `str` into a series of tokens and return them. The tokens are just 2-element Array tuples with a type and the actual content. If this function is called with a block, the type and text parts of each token will be yielded to it one at a time as they are extracted.
transform_anchors	Apply Markdown anchor transforms to a copy of the specified `str` with the given render state `rs` and return it.
transform_auto_links	Transform URLs in a copy of the specified `str` into links and return it.
transform_block_quotes	Transform Markdown-style blockquotes in a copy of the specified `str` and return it.
transform_code_blocks	Transform Markdown-style codeblocks in a copy of the specified `str` and return it.
transform_code_spans	Transform backticked spans into `spans.`
transform_headers	Apply Markdown header transforms to a copy of the given `str` amd render state `rs` and return the result.
transform_hrules	Transform any Markdown-style horizontal rules in a copy of the specified `str` and return it.
transform_images	Turn image markup into image tags.
transform_italic_and_bold	Transform italic- and bold-encoded text in a copy of the specified `str` and return it.
transform_list_items	Transform list items in a copy of the given `str` and return it.
transform_lists	Transform Markdown-style lists in a copy of the specified `str` and return it.
unescape_special_chars	Swap escaped special characters in a copy of the given `str` and return it.

BlueCloth

Ruby on Rails documentation... on Rails.