Markdown Implementations

Gmas / Ruby.markdown Forked from avdi/Ruby.markdown. Created Feb 17, 2014. Star 0 Fork 0; Star Code Revisions 1. What would you like to do? The Markdown Guide is a free and open-source reference guide that explains how to use Markdown, the simple and easy-to-use markup language you can use to format virtually any document. Get Started DigitalOcean App Platform, a new PaaS that gets your apps to market, faster. The RDoc Markdown parser has the following built-in behaviors that cannot be disabled. Underscores embedded in words are never interpreted as emphasis. (While the markdown dingus emphasizes in-word underscores, neither the Markdown syntax nor MarkdownTest mention this behavior.) For HTML output, RDoc always auto-links bare URLs. Some styles failed to load. 😵 Please try reloading this page. I use markdown for virtually any work I do. I actually wrote then entire Hello Rails course in markdown. This blog's post editor is based in markdown as well. It's safe to say I love it over any other type of word editor out there. Adding support for it in a Ruby on Rails app is quite trivial thanks to a few gems out there.

Either direct or other lists

• stackoverflow Question 11 lists some and references

Specific implementations

In Python universe, some packages. There are more.

• Markdown with its features

In Perl, there is a package:

Wikipedia has a list that is reproduced here, so that we can add/remove columns and Markdown processors.

Alternative lightweight markup formats

RDoc::Markdown as described by the markdownsyntax.

To choose Markdown as your only default formatsee Saved Options atRDoc::Options for instructions on setting up a.doc_options file to store your project default.

Usage

Here is a brief example of using this parse to read a markdown file byhand.

Extensions

The following markdown extensions are supported by the parser, but not allare used in RDoc output by default.

RDoc

The RDocMarkdownparser has the following built-in behaviors that cannot be disabled.

Underscores embedded in words are never interpreted as emphasis. (While themarkdowndingus emphasizes in-word underscores, neither the Markdown syntax nor MarkdownTest mention thisbehavior.)

For HTML output, RDoc always auto-links bareURLs.

Break on Newline

The #break_on_newlineextension converts all newlines into hard line breaks as in Github FlavoredMarkdown. This extension is disabled by default.

CSS

The css extension enables CSSblocks to be included in the output, but they are not used for any built-inRDoc output format. This extension is disabledby default.

Example:

Definition Lists

The #definition_listsextension allows definition lists using the PHPMarkdown Extra syntax, but only one label and definition are supportedat this time. This extension is enabled by default.

Example:

Produces:

A small furry mammal that seems to sleep a lot

A little insect that is known to enjoy picnics

Strike

Example:

Produces:

This is ~~striked~~.

Github

The github extension enables apartial set of Github FlavoredMarkdown. This extension is enabled by default.

Supported github extensions include:

Fenced code blocks

Use ``` around a block of code instead of indenting it fourspaces.

Syntax highlighting

Use ``` ruby as the start of a code fence to add syntaxhighlighting. (Currently only ruby syntax is supported).

HTML

Ruby Markdown Download

Enables raw HTML to be included in the output. This extension is enabled bydefault.

Example:

Notes

The notes extension enablesfootnote support. This extension is enabled by default.

Example:

Produces:

Here is some text¹including an inline footnote ²

Limitations

Ruby Markdownify

• Link titles are not used

• Footnotes are collapsed into a single paragraph

Author

This markdown parser is a port to kpeg from peg-markdown by JohnMacFarlane.

It is used under the MIT license:

Permission is hereby granted, free of charge, to any person obtaining acopy of this software and associated documentation files (the “Software”),to deal in the Software without restriction, including without limitationthe rights to use, copy, modify, merge, publish, distribute, sublicense,and/or sell copies of the Software, and to permit persons to whom theSoftware is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISINGFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHERDEALINGS IN THE SOFTWARE.

The port to kpeg was performed by Eric Hodel and Evan Phoenix

¹ With the footnotetext down at the bottom

Ruby Markdown Game

² for short footnotes