- home :: github.com/geraldb/markdown
- bugs :: github.com/geraldb/markdown/issues
- gem :: rubygems.org/gems/markdown
- rdoc :: rubydoc.info/gems/markdown
The Markdown Engine Wrapper (
markdown) Ruby gem lets you use
your markdown library of choice. Preconfigured markdown libraries include
require 'markdown' Markdown.new( 'Hello World' ).to_html # => "<p>Hello World</p>\n"
markdown HTTP (JSON) API running
GET /markdown?text=Hello+World! <p>Hello World!</p>
To start your own server/service use
markdown serve. See command line below.
markdown gem includes a little command line tool. Try
markdown -h for details:
markdown - Lets you convert plain text documents to hypertext with your Markdown engine of choice and preprocessing text filters. Usage: markdown [options] files_or_dirs -o, --output PATH Output Path -v, --verbose Show debug trace Examples: markdown # Process all documents in working folder (that is, .) markdown quickref # Process document or folder using Markdown markdown quickref.text # Process document using Markdown markdown -o site quickref # Output documents to site folder Note: markdown server # Starts builtin markdown server # (aliases for server include serve, service, s)
The default (fallback) Markdown library is
kramdown. To use your markdown engine of choice
configure the wrapper. The wrapper
uses the following lookup order to find the markdown engine:
libs: - redcarpet - kramdown
Markdown libraries in the list get loaded on a first-come first-serve principle,
that is, the first library
require'd successfully will get used.
You can also pass along options to your Markdown library. Example:
## Let's use the Redcarpet library lib: redcarpet redcarpet: extensions: - no_intra_emphasis - fenced_code_blocks - tables - strikethrough
For the command line tool only you can configure preprocessing filters to allow comments, Ruby helpers, and much more. Example:
## Let's use percent style comments filters: - comments-percent-style
Now the filter will strip comment lines starting with percent (that is, %). Example:
%%%%%%%%%%%%%%%% % Some Headers Title: Web Services REST-Style: Universal Identifiers, Formats & Protocols
Title: Web Services REST-Style: Universal Identifiers, Formats & Protocols
before the text gets passed along to the markdown engine. The filter
also supports multiline comments with
%end pairs. Example:
%begin Using modern browser such as Firefox, Chrome and Safari you can now theme your slide shows using using "loss-free" vector graphics in plain old CSS. Thanks to gradient support in backgrounds in CSS3. %end
%comment Using modern browser such as Firefox, Chrome and Safari you can now theme your slide shows using using "loss-free" vector graphics in plain old CSS. Thanks to gradient support in backgrounds in CSS3. %end
Note: As a shortcut using a single
%end directive (that is, without a leading
will skip everything until the end of the document.
For more about filters see the
The Markdown wrapper lets you configure different converter methods
for each markdown engine. By default
the converter method
<lib>_to_html gets used
(for example, the default converter for
pandoc-ruby: converter: pandoc-ruby-to-s5
Just install the gem:
$ gem install markdown
slideshow (also known as Slide Show (S9)) gem
that lets you create slide shows
and author slides in plain text using a wiki-style markup language that's easy-to-write and easy-to-read.
multi_markdowngem by Hal Brodigan (aka postmodern)
markdown_metagem by Charles Oliver Nutter (aka headius)
Send them along to the Free Web Slide Show Alternatives (S5, S6, S9, Slidy And Friends) Forum/Mailing List. Thanks!
markdown scripts are dedicated to the public domain.
Use it as you please with no restrictions whatsoever.