U:RDoc::NormalClass[iI"
Markdown:ETI"RDoc::Markdown;TI"Object;To:RDoc::Markup::Document:@parts[o;;[9o:RDoc::Markup::Paragraph;[I"nRDoc::Markdown as described by the {markdown syntax}[http://daringfireball.net/projects/markdown/syntax].;To; ;[I"To choose Markdown as your only default format see
RDoc::Options@Saved+Options for instructions on setting up a .doc_options
file to store your project default.;TS:RDoc::Markup::Heading:
leveli: textI"
Usage;To; ;[I"QHere is a brief example of using this parse to read a markdown file by hand.;To:RDoc::Markup::Verbatim;[
I"#data = File.read("README.md")
;TI"Bformatter = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)
;TI"9html = RDoc::Markdown.parse(data).accept(formatter)
;TI"
;TI"# do something with html
;T:@format0S;
;i;I"Extensions;To; ;[I"sThe following markdown extensions are supported by the parser, but not all
are used in RDoc output by default.;TS;
;i;I" RDoc;To; ;[I"[The RDoc Markdown parser has the following built-in behaviors that cannot be
disabled.;To; ;[I"öUnderscores embedded in words are never interpreted as emphasis. (While the
{markdown dingus}[http://daringfireball.net/projects/markdown/dingus] emphasizes in-word underscores, neither the
Markdown syntax nor MarkdownTest mention this behavior.);To; ;[I"7For HTML output, RDoc always auto-links bare URLs.;TS;
;i;I"Break on Newline;To; ;[I"ÇThe break_on_newline extension converts all newlines into hard line breaks
as in {Github Flavored Markdown}[http://github.github.com/github-flavored-markdown/]. This extension is disabled by
default.;TS;
;i;I"CSS;To; ;[I"¥The #css extension enables CSS blocks to be included in the output, but they
are not used for any built-in RDoc output format. This extension is disabled
by default.;To; ;[I"
Example:;To;
;[I"
;T;0S;
;i;I"Definition Lists;To; ;[I"ûThe definition_lists extension allows definition lists using the {PHP Markdown Extra syntax}[http://michelf.com/projects/php-markdown/extra/#def-list], but only one label and definition are supported
at this time. This extension is enabled by default.;To; ;[I"
Example:;To;
;[I"ucat
: A small furry mammal
that seems to sleep a lot
ant
: A little insect that is known
to enjoy picnics
;T;0o; ;[I"Produces:;To:RDoc::Markup::List:
@type: NOTE:@items[o:RDoc::Markup::ListItem:@label[I"cat;T;[o; ;[I"3A small furry mammal
that seems to sleep a lot;To;;[I"ant;T;[o; ;[I"3A little insect that is known
to enjoy picnics;TS;
;i;I"Github;To; ;[I"¤The #github extension enables a partial set of {Github Flavored Markdown}[http://github.github.com/github-flavored-markdown/]. This extension is enabled by default.;To; ;[I")Supported github extensions include:;TS;
;i ;I"Fenced code blocks;To; ;[I"UUse ```
around a block of code instead of indenting it four spaces.;TS;
;i ;I"Syntax highlighting;To; ;[I"ŠUse ``` ruby
as the start of a code fence to add syntax highlighting.
(Currently only ruby
syntax is supported).;TS;
;i;I" HTML;To; ;[I"YEnables raw HTML to be included in the output. This extension is enabled by
default.;To; ;[I"
Example:;To;
;[I"