Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
ruby / usr / share / ri / 2.2.0 / system / RDoc / Markdown / cdesc-Markdown.ri
Size: Mime:
U:RDoc::NormalClass[iI"
Markdown:ETI"RDoc::Markdown;FI"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 <code>.doc_options</code>
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":html = 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"<style type="text/css">
;TI"h1 { font-size: 3em }
;TI"</style>
;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 <code>```</code> around a block of code instead of indenting it four spaces.;TS;
;i	;I"Syntax highlighting;To;	;[I"ŠUse <code>``` ruby</code> as the start of a code fence to add syntax highlighting.
(Currently only <code>ruby</code> 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"
<table>
;TI"	...
;TI"</table>
;T;0S;
;i;I"
Notes;To;	;[I"YThe #notes extension enables footnote support. This extension is enabled by
default.;To;	;[I"
Example:;To;
;[
I"OHere is some text[^1] including an inline footnote ^[for short footnotes]
;TI"
;TI"	...
;TI"
;TI"5[^1]: With the footnote text down at the bottom
;T;0o;	;[I"Produces:;To;	;[I"{Here is some text{*1}[rdoc-label:foottext-1:footmark-1] including an inline footnote {*2}[rdoc-label:foottext-2:footmark-2];TS;
;i;I"Limitations;To;;:BULLET;[o;;0;[o;	;[I"Link titles are not used;To;;0;[o;	;[I"4Footnotes are collapsed into a single paragraph;TS;
;i;I"Author;To;	;[I"xThis markdown parser is a port to kpeg from {peg-markdown}[https://github.com/jgm/peg-markdown] by
John MacFarlane.;To;	;[I"&It is used under the MIT license:;To;	;[I"°Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:;To;	;[I"~The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.;To;	;[I"ÌTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.;To;	;[I"BThe port to kpeg was performed by Eric Hodel and Evan Phoenix;TS:RDoc::Markup::Rule:weightio;	;[I"U{^1}[rdoc-label:footmark-1:foottext-1] With the footnote text down at the bottom;To;	;[I"?{^2}[rdoc-label:footmark-2:foottext-2] for short footnotes;T:
@fileI"lib/rdoc/markdown.rb;T:0@omit_headings_from_table_of_contents_below0;0;0[[U:RDoc::Constant[iI"EXTENSIONS;FI"RDoc::Markdown::EXTENSIONS;F00o;;[o;	;[I"Supported extensions;T;@¸;0@¸@cRDoc::NormalClass0U;[iI"DEFAULT_EXTENSIONS;FI"'RDoc::Markdown::DEFAULT_EXTENSIONS;F00o;;[o;	;[I""Extensions enabled by default;T;@¸;0@¸@@Ä0U;[iI"HTML_ENTITIES;FI""RDoc::Markdown::HTML_ENTITIES;F00o;;[o;	;[I",HTML entity name map for RDoc::Markdown;T;I""lib/rdoc/markdown/entities.rb;T;0@×@@Ä0[[[I"
class;T[[:public[[I"extension;FI"lib/rdoc/markdown.rb;T[I"new;T@á[I"
parse;F@á[:protected[[:private[[I"
instance;T[[;[[I"break_on_newline;T@á[I"css;T@á[I"definition_lists;T@á[I"
emphasis;F@á[I"extension;F@á[I"extension?;F@á[I"github;T@á[I"	html;T@á[I"link_to;F@á[I"list_item_from;F@á[I"	note;F@á[I"
note_for;F@á[I"
notes;T@á[I"orig_initialize;F@á[I"paragraph;F@á[I"
parse;F@á[I"peg_parse;F@á[I"reference;F@á[I"strong;F@á[;[[;[[[U:RDoc::Context::Section[i0o;;[;0;0U;[iI"Extensions;To;;[;0;0[@¸@×I"&lib/rdoc/markdown/literals_1_9.rb;T@¸cRDoc::TopLevel