RubyGems - ronn - Versions diffs - 0.4 - Mend

ronn 0.4

Files changed (37) hide show

data/COPYING +21 -0
data/README.md +135 -0
data/Rakefile +114 -0
data/bin/ron +2 -0
data/bin/ronn +147 -0
data/lib/ronn.rb +16 -0
data/lib/ronn/document.rb +288 -0
data/lib/ronn/layout.html +75 -0
data/lib/ronn/roff.rb +197 -0
data/man/markdown.5 +1513 -0
data/man/markdown.5.ronn +881 -0
data/man/ronn.1 +220 -0
data/man/ronn.1.ronn +158 -0
data/man/ronn.5 +190 -0
data/man/ronn.5.ronn +152 -0
data/man/ronn.7 +195 -0
data/man/ronn.7.ronn +135 -0
data/ronn.gemspec +69 -0
data/test/angle_bracket_syntax.html +13 -0
data/test/angle_bracket_syntax.ronn +12 -0
data/test/basic_document.html +4 -0
data/test/basic_document.ronn +4 -0
data/test/custom_title_document.html +4 -0
data/test/custom_title_document.ronn +5 -0
data/test/definition_list_syntax.html +16 -0
data/test/definition_list_syntax.ronn +18 -0
data/test/document_test.rb +88 -0
data/test/entity_encoding_test.html +10 -0
data/test/entity_encoding_test.roff +19 -0
data/test/entity_encoding_test.ronn +8 -0
data/test/middle_paragraph.html +10 -0
data/test/middle_paragraph.roff +13 -0
data/test/middle_paragraph.ronn +10 -0
data/test/ronn_test.rb +78 -0
data/test/titleless_document.html +2 -0
data/test/titleless_document.ronn +2 -0
metadata +141 -0

@@ -0,0 +1,75 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v#{Ronn::VERSION}'>
+  <title>#{name}(#{section})#{tagline ? " -- " + tagline : ''}</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+<h1 class='man-title'>#{name}(#{section})</h1>
+<ol class='head man'>
+  <li class='tl'>#{name if section}#{"("+section+")" if name and section}</li>
+  <li class='tc'>#{manual}</li>
+  <li class='tr'>#{name if section}#{"("+section+")" if name and section}</li>
+</ol>
+#{html}
+<ol class='foot man'>
+  <li class='tl'>#{organization}</li>
+  <li class='tc'>#{date.strftime('%B %Y')}</li>
+  <li class='tr'>#{name if section}#{"("+section+")" if name and section}</li>
+</ol>
+</div>
+</body>
+</html>

data/lib/ronn/roff.rb ADDED

@@ -0,0 +1,197 @@
+require 'hpricot'
+module Ronn
+  class RoffFilter
+    # Convert Ronn HTML to roff.
+    def initialize(html, name, section, tagline, manual=nil, version=nil, date=nil)
+      @buf = []
+      title_heading name, section, tagline, manual, version, date
+      html = Hpricot(html)
+      block_filter(html)
+      write "\n"
+    end
+    def to_s
+      @buf.join.gsub(/\s+$/, '')
+    end
+  protected
+    def previous(node)
+      if node.respond_to?(:previous)
+        prev = node.previous
+        prev = prev.previous until prev.nil? || prev.elem?
+        prev
+      end
+    end
+    def title_heading(name, section, tagline, manual, version, date)
+      comment "generated with Ronn/v#{Ronn::VERSION}"
+      comment "http://github.com/rtomayko/ronn/"
+      macro "TH", %["#{escape(name.upcase)}" "#{section}" "#{date.strftime('%B %Y')}" "#{version}" "#{manual}"]
+    end
+    def block_filter(node)
+      if node.kind_of?(Array) || node.kind_of?(Hpricot::Elements)
+        node.each { |ch| block_filter(ch) }
+      elsif node.doc?
+        block_filter(node.children)
+      elsif node.text?
+        return if node.to_html =~ /^\s*$/m
+        warn "unexpected text: %p",  node
+      elsif node.elem?
+        case node.name
+        when 'h2'
+          macro "SH", quote(escape(node.html))
+        when 'h3'
+          macro "SS", quote(escape(node.html))
+        when 'p'
+          prev = previous(node)
+          if prev && %w[dd li].include?(node.parent.name)
+            macro "IP"
+          elsif prev && !%w[h1 h2 h3].include?(prev.name)
+            macro "P"
+          end
+          inline_filter(node.children)
+        when 'pre'
+          prev = previous(node)
+          indent = prev.nil? || !%w[h1 h2 h3].include?(prev.name)
+          macro "IP", %w["" 4] if indent
+          macro "nf"
+          write "\n"
+          inline_filter(node.search('code > *'))
+          macro "fi"
+          macro "IP", %w["" 0] if indent
+        when 'dl'
+          macro "TP"
+          block_filter(node.children)
+        when 'dt'
+          prev = previous(node)
+          macro "TP" unless prev.nil?
+          inline_filter(node.children)
+          write "\n"
+        when 'dd'
+          if node.search('p').any?
+            block_filter(node.children)
+          else
+            inline_filter(node.children)
+          end
+          write "\n"
+        # when 'ol'
+        #   macro "IP", '1.'
+        #   block_filter(node.children)
+        when 'ul'
+          block_filter(node.children)
+          macro "IP", %w["" 0]
+        when 'li'
+          case node.parent.name
+          when 'ul'
+            macro "IP", %w["\(bu" 4]
+          end
+          if node.search('p|ol|ul|dl|div').any?
+            block_filter(node.children)
+          else
+            inline_filter(node.children)
+          end
+          write "\n"
+        else
+          warn "unrecognized block tag: %p", node.name
+        end
+      else
+        fail "unexpected node: #{node.inspect}"
+      end
+    end
+    def inline_filter(node)
+      if node.kind_of?(Array) || node.kind_of?(Hpricot::Elements)
+        node.each { |ch| inline_filter(ch) }
+      elsif node.text?
+        prev = previous(node)
+        text = node.to_html.dup
+        text.sub!(/^\n+/m, '') if prev && prev.name == 'br'
+        if node.previous.nil? && node.next
+          text.sub!(/\n+$/m, '')
+        else
+          text.sub!(/\n+$/m, ' ')
+        end
+        write escape(text)
+      elsif node.elem?
+        case node.name
+        when 'code'
+          write '\fB'
+          inline_filter(node.children)
+          write '\fR'
+        when 'b', 'strong', 'kbd', 'samp'
+          write '\fB'
+          inline_filter(node.children)
+          write '\fR'
+        when 'var', 'em', 'i', 'u'
+          write '\fI'
+          inline_filter(node.children)
+          write '\fR'
+        when 'br'
+          macro 'br'
+        when 'a'
+          write '\fI'
+          inline_filter(node.children)
+          write '\fR'
+        else
+          warn "unrecognized inline tag: %p", node.name
+        end
+      else
+        fail "unexpected node: #{node.inspect}"
+      end
+    end
+    def macro(name, value=nil)
+      writeln ".\n.#{[name, value].compact.join(' ')}"
+    end
+    def escape(text)
+      text.
+        gsub(/[\\-]/)  { |m| "\\#{m}" }.
+        gsub('&nbsp;', ' ').
+        gsub('&lt;',   '<').
+        gsub('&gt;',   '>').
+        gsub('&amp;',  '&')
+    end
+    def quote(text)
+      "\"#{text}\""
+    end
+    # write text to output buffer
+    def write(text)
+      @buf << text unless text.nil? || text.empty?
+    end
+    # write text to output buffer on a new line.
+    def writeln(text)
+      write "\n" if @buf.last && @buf.last[-1] != ?\n
+      write text
+      write "\n"
+    end
+    def comment(text)
+      writeln %[.\\" #{text}]
+    end
+    def warn(text, *args)
+      $stderr.puts "warn: #{text}" % args
+    end
+  end
+end

data/man/markdown.5 ADDED

@@ -0,0 +1,1513 @@
+.\" generated with Ronn/v0.3
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "MARKDOWN" "5" "March 2010" "Ryan Tomayko" "Ronn Manual"
+.
+.SH "NAME"
+\fBmarkdown\fR \-\- humane markup syntax
+.
+.SH "SYNOPSIS"
+.
+.nf
+# Header 1 #
+## Header 2 ##
+### Header 3 ###             (Hashes on right are optional)
+#### Header 4 ####
+##### Header 5 #####
+This is a paragraph, which is text surrounded by whitespace.
+Paragraphs can be on one line (or many), and can drone on for
+hours.
+[Reference style links][1] and [inline links](http://example.com)
+[1]: http://example.com "Title is optional"
+Inline markup like _italics_,  **bold**, and `code()`.
+![picture alt](/images/photo.jpeg "Title is optional")
+> Blockquotes are like quoted text in email replies
+>> And, they can be nested
+    code blocks are for preformatted
+    text and must be indented with four spaces
+* Bullet lists are easy too
+  * You can
+  * even
+  * nest them
+\- Another one
++ Another one
+.
+.fi
+.
+.SH "DESCRIPTION"
+.
+.SS "Philosophy"
+Markdown is intended to be as easy\-to\-read and easy\-to\-write as is feasible.
+.
+.P
+Readability, however, is emphasized above all else. A Markdown\-formatted
+document should be publishable as\-is, as plain text, without looking
+like it's been marked up with tags or formatting instructions. While
+Markdown's syntax has been influenced by several existing text\-to\-HTML
+filters \-\- including \fISetext\fR, \fIatx\fR, \fITextile\fR, \fIreStructuredText\fR, \fIGrutatext\fR, and \fIEtText\fR \-\- the single biggest source of
+inspiration for Markdown's syntax is the format of plain text email.
+.
+.P
+To this end, Markdown's syntax is comprised entirely of punctuation
+characters, which punctuation characters have been carefully chosen so
+as to look like what they mean. E.g., asterisks around a word actually
+look like *emphasis*. Markdown lists look like, well, lists. Even
+blockquotes look like quoted passages of text, assuming you've ever
+used email.
+.
+.SS "Inline HTML"
+Markdown's syntax is intended for one purpose: to be used as a
+format for \fIwriting\fR for the web.
+.
+.P
+Markdown is not a replacement for HTML, or even close to it. Its
+syntax is very small, corresponding only to a very small subset of
+HTML tags. The idea is \fInot\fR to create a syntax that makes it easier
+to insert HTML tags. In my opinion, HTML tags are already easy to
+insert. The idea for Markdown is to make it easy to read, write, and
+edit prose. HTML is a \fIpublishing\fR format; Markdown is a \fIwriting\fR
+format. Thus, Markdown's formatting syntax only addresses issues that
+can be conveyed in plain text.
+.
+.P
+For any markup that is not covered by Markdown's syntax, you simply
+use HTML itself. There's no need to preface it or delimit it to
+indicate that you're switching from Markdown to HTML; you just use
+the tags.
+.
+.P
+The only restrictions are that block\-level HTML elements \-\- e.g. \fB<div>\fR, \fB<table>\fR, \fB<pre>\fR, \fB<p>\fR, etc. \-\- must be separated from surrounding
+content by blank lines, and the start and end tags of the block should
+not be indented with tabs or spaces. Markdown is smart enough not
+to add extra (unwanted) \fB<p>\fR tags around HTML block\-level tags.
+.
+.P
+For example, to add an HTML table to a Markdown article:
+.
+.IP "" 4
+.
+.nf
+This is a regular paragraph.
+<table>
+    <tr>
+        <td>Foo</td>
+    </tr>
+</table>
+This is another regular paragraph.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Note that Markdown formatting syntax is not processed within block\-level
+HTML tags. E.g., you can't use Markdown\-style \fB*emphasis*\fR inside an
+HTML block.
+.
+.P
+Span\-level HTML tags \-\- e.g. \fB<span>\fR, \fB<cite>\fR, or \fB<del>\fR \-\- can be
+used anywhere in a Markdown paragraph, list item, or header. If you
+want, you can even use HTML tags instead of Markdown formatting; e.g. if
+you'd prefer to use HTML \fB<a>\fR or \fB<img>\fR tags instead of Markdown's
+link or image syntax, go right ahead.
+.
+.P
+Unlike block\-level HTML tags, Markdown syntax \fIis\fR processed within
+span\-level tags.
+.
+.SS "Automatic Escaping for Special Characters"
+In HTML, there are two characters that demand special treatment: \fB<\fR
+and \fB&\fR. Left angle brackets are used to start tags; ampersands are
+used to denote HTML entities. If you want to use them as literal
+characters, you must escape them as entities, e.g. \fB&lt;\fR, and \fB&amp;\fR.
+.
+.P
+Ampersands in particular are bedeviling for web writers. If you want to
+write about 'AT&T', you need to write '\fBAT&amp;T\fR'. You even need to
+escape ampersands within URLs. Thus, if you want to link to:
+.
+.IP "" 4
+.
+.nf
+http://images.google.com/images?num=30&q=larry+bird
+.
+.fi
+.
+.IP "" 0
+.
+.P
+you need to encode the URL as:
+.
+.IP "" 4
+.
+.nf
+http://images.google.com/images?num=30&amp;q=larry+bird
+.
+.fi
+.
+.IP "" 0
+.
+.P
+in your anchor tag \fBhref\fR attribute. Needless to say, this is easy to
+forget, and is probably the single most common source of HTML validation
+errors in otherwise well\-marked\-up web sites.
+.
+.P
+Markdown allows you to use these characters naturally, taking care of
+all the necessary escaping for you. If you use an ampersand as part of
+an HTML entity, it remains unchanged; otherwise it will be translated
+into \fB&amp;\fR.
+.
+.P
+So, if you want to include a copyright symbol in your article, you can write:
+.
+.IP "" 4
+.
+.nf
+&copy;
+.
+.fi
+.
+.IP "" 0
+.
+.P
+and Markdown will leave it alone. But if you write:
+.
+.IP "" 4
+.
+.nf
+AT&T
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Markdown will translate it to:
+.
+.IP "" 4
+.
+.nf
+AT&amp;T
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Similarly, because Markdown supports \fIinline HTML\fR, if you use
+angle brackets as delimiters for HTML tags, Markdown will treat them as
+such. But if you write:
+.
+.IP "" 4
+.
+.nf
+4 < 5
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Markdown will translate it to:
+.
+.IP "" 4
+.
+.nf
+4 &lt; 5
+.
+.fi
+.
+.IP "" 0
+.
+.P
+However, inside Markdown code spans and blocks, angle brackets and
+ampersands are \fIalways\fR encoded automatically. This makes it easy to use
+Markdown to write about HTML code. (As opposed to raw HTML, which is a
+terrible format for writing about HTML syntax, because every single \fB<\fR
+and \fB&\fR in your example code needs to be escaped.)
+.
+.SH "BLOCK ELEMENTS"
+.
+.SS "Paragraphs and Line Breaks"
+A paragraph is simply one or more consecutive lines of text, separated
+by one or more blank lines. (A blank line is any line that looks like a
+blank line \-\- a line containing nothing but spaces or tabs is considered
+blank.) Normal paragraphs should not be indented with spaces or tabs.
+.
+.P
+The implication of the "one or more consecutive lines of text" rule is
+that Markdown supports "hard\-wrapped" text paragraphs. This differs
+significantly from most other text\-to\-HTML formatters (including Movable
+Type's "Convert Line Breaks" option) which translate every line break
+character in a paragraph into a \fB<br />\fR tag.
+.
+.P
+When you \fIdo\fR want to insert a \fB<br />\fR break tag using Markdown, you
+end a line with two or more spaces, then type return.
+.
+.P
+Yes, this takes a tad more effort to create a \fB<br />\fR, but a simplistic
+"every line break is a \fB<br />\fR" rule wouldn't work for Markdown.
+Markdown's email\-style \fIblockquoting\fR and multi\-paragraph \fIlist items\fR
+work best \-\- and look better \-\- when you format them with hard breaks.
+.
+.SS "Headers"
+Markdown supports two styles of headers, \fISetext\fR and \fIatx\fR.
+.
+.P
+Setext\-style headers are "underlined" using equal signs (for first\-level
+headers) and dashes (for second\-level headers). For example:
+.
+.IP "" 4
+.
+.nf
+This is an H1
+=============
+This is an H2
+\-\-\-\-\-\-\-\-\-\-\-\-\-
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Any number of underlining \fB=\fR's or \fB\-\fR's will work.
+.
+.P
+Atx\-style headers use 1\-6 hash characters at the start of the line,
+corresponding to header levels 1\-6. For example:
+.
+.IP "" 4
+.
+.nf
+# This is an H1
+## This is an H2
+###### This is an H6
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Optionally, you may "close" atx\-style headers. This is purely
+cosmetic \-\- you can use this if you think it looks better. The
+closing hashes don't even need to match the number of hashes
+used to open the header. (The number of opening hashes
+determines the header level.) :
+.
+.IP "" 4
+.
+.nf
+# This is an H1 #
+## This is an H2 ##
+### This is an H3 ######
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Blockquotes"
+Markdown uses email\-style \fB>\fR characters for blockquoting. If you're
+familiar with quoting passages of text in an email message, then you
+know how to create a blockquote in Markdown. It looks best if you hard
+wrap the text and put a \fB>\fR before every line:
+.
+.IP "" 4
+.
+.nf
+> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
+> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
+> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
+>
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Markdown allows you to be lazy and only put the \fB>\fR before the first
+line of a hard\-wrapped paragraph:
+.
+.IP "" 4
+.
+.nf
+> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
+consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
+Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+id sem consectetuer libero luctus adipiscing.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Blockquotes can be nested (i.e. a blockquote\-in\-a\-blockquote) by
+adding additional levels of \fB>\fR:
+.
+.IP "" 4
+.
+.nf
+> This is the first level of quoting.
+>
+> > This is nested blockquote.
+>
+> Back to the first level.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Blockquotes can contain other Markdown elements, including headers, lists,
+and code blocks:
+.
+.IP "" 4
+.
+.nf
+> ## This is a header.
+>
+> 1.   This is the first list item.
+> 2.   This is the second list item.
+>
+> Here's some example code:
+>
+>     return shell_exec("echo $input | $markdown_script");
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Any decent text editor should make email\-style quoting easy. For
+example, with BBEdit, you can make a selection and choose Increase
+Quote Level from the Text menu.
+.
+.SS "Lists"
+Markdown supports ordered (numbered) and unordered (bulleted) lists.
+.
+.P
+Unordered lists use asterisks, pluses, and hyphens \-\- interchangably
+\-\- as list markers:
+.
+.IP "" 4
+.
+.nf
+*   Red
+*   Green
+*   Blue
+.
+.fi
+.
+.IP "" 0
+.
+.P
+is equivalent to:
+.
+.IP "" 4
+.
+.nf
++   Red
++   Green
++   Blue
+.
+.fi
+.
+.IP "" 0
+.
+.P
+and:
+.
+.IP "" 4
+.
+.nf
+\-   Red
+\-   Green
+\-   Blue
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Ordered lists use numbers followed by periods:
+.
+.IP "" 4
+.
+.nf
+1.  Bird
+2.  McHale
+3.  Parish
+.
+.fi
+.
+.IP "" 0
+.
+.P
+It's important to note that the actual numbers you use to mark the
+list have no effect on the HTML output Markdown produces. The HTML
+Markdown produces from the above list is:
+.
+.IP "" 4
+.
+.nf
+<ol>
+<li>Bird</li>
+<li>McHale</li>
+<li>Parish</li>
+</ol>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If you instead wrote the list in Markdown like this:
+.
+.IP "" 4
+.
+.nf
+1.  Bird
+1.  McHale
+1.  Parish
+.
+.fi
+.
+.IP "" 0
+.
+.P
+or even:
+.
+.IP "" 4
+.
+.nf
+3. Bird
+1. McHale
+8. Parish
+.
+.fi
+.
+.IP "" 0
+.
+.P
+you'd get the exact same HTML output. The point is, if you want to,
+you can use ordinal numbers in your ordered Markdown lists, so that
+the numbers in your source match the numbers in your published HTML.
+But if you want to be lazy, you don't have to.
+.
+.P
+If you do use lazy list numbering, however, you should still start the
+list with the number 1. At some point in the future, Markdown may support
+starting ordered lists at an arbitrary number.
+.
+.P
+List markers typically start at the left margin, but may be indented by
+up to three spaces. List markers must be followed by one or more spaces
+or a tab.
+.
+.P
+To make lists look nice, you can wrap items with hanging indents:
+.
+.IP "" 4
+.
+.nf
+*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+    Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
+    viverra nec, fringilla in, laoreet vitae, risus.
+*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
+    Suspendisse id sem consectetuer libero luctus adipiscing.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+But if you want to be lazy, you don't have to:
+.
+.IP "" 4
+.
+.nf
+*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
+Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
+viverra nec, fringilla in, laoreet vitae, risus.
+*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
+Suspendisse id sem consectetuer libero luctus adipiscing.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If list items are separated by blank lines, Markdown will wrap the
+items in \fB<p>\fR tags in the HTML output. For example, this input:
+.
+.IP "" 4
+.
+.nf
+*   Bird
+*   Magic
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will turn into:
+.
+.IP "" 4
+.
+.nf
+<ul>
+<li>Bird</li>
+<li>Magic</li>
+</ul>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+But this:
+.
+.IP "" 4
+.
+.nf
+*   Bird
+*   Magic
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will turn into:
+.
+.IP "" 4
+.
+.nf
+<ul>
+<li><p>Bird</p></li>
+<li><p>Magic</p></li>
+</ul>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+List items may consist of multiple paragraphs. Each subsequent
+paragraph in a list item must be indented by either 4 spaces
+or one tab:
+.
+.IP "" 4
+.
+.nf
+1.  This is a list item with two paragraphs. Lorem ipsum dolor
+    sit amet, consectetuer adipiscing elit. Aliquam hendrerit
+    mi posuere lectus.
+    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
+    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
+    sit amet velit.
+2.  Suspendisse id sem consectetuer libero luctus adipiscing.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+It looks nice if you indent every line of the subsequent
+paragraphs, but here again, Markdown will allow you to be
+lazy:
+.
+.IP "" 4
+.
+.nf
+*   This is a list item with two paragraphs.
+    This is the second paragraph in the list item. You're
+only required to indent the first line. Lorem ipsum dolor
+sit amet, consectetuer adipiscing elit.
+*   Another item in the same list.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To put a blockquote within a list item, the blockquote's \fB>\fR
+delimiters need to be indented:
+.
+.IP "" 4
+.
+.nf
+*   A list item with a blockquote:
+    > This is a blockquote
+    > inside a list item.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To put a code block within a list item, the code block needs
+to be indented \fItwice\fR \-\- 8 spaces or two tabs:
+.
+.IP "" 4
+.
+.nf
+*   A list item with a code block:
+        <code goes here>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+It's worth noting that it's possible to trigger an ordered list by
+accident, by writing something like this:
+.
+.IP "" 4
+.
+.nf
+1986. What a great season.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+In other words, a \fInumber\-period\-space\fR sequence at the beginning of a
+line. To avoid this, you can backslash\-escape the period:
+.
+.IP "" 4
+.
+.nf
+1986\\. What a great season.
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Code Blocks"
+Pre\-formatted code blocks are used for writing about programming or
+markup source code. Rather than forming normal paragraphs, the lines
+of a code block are interpreted literally. Markdown wraps a code block
+in both \fB<pre>\fR and \fB<code>\fR tags.
+.
+.P
+To produce a code block in Markdown, simply indent every line of the
+block by at least 4 spaces or 1 tab. For example, given this input:
+.
+.IP "" 4
+.
+.nf
+This is a normal paragraph:
+    This is a code block.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Markdown will generate:
+.
+.IP "" 4
+.
+.nf
+<p>This is a normal paragraph:</p>
+<pre><code>This is a code block.
+</code></pre>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+One level of indentation \-\- 4 spaces or 1 tab \-\- is removed from each
+line of the code block. For example, this:
+.
+.IP "" 4
+.
+.nf
+Here is an example of AppleScript:
+    tell application "Foo"
+        beep
+    end tell
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will turn into:
+.
+.IP "" 4
+.
+.nf
+<p>Here is an example of AppleScript:</p>
+<pre><code>tell application "Foo"
+    beep
+end tell
+</code></pre>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+A code block continues until it reaches a line that is not indented
+(or the end of the article).
+.
+.P
+Within a code block, ampersands (\fB&\fR) and angle brackets (\fB<\fR and \fB>\fR)
+are automatically converted into HTML entities. This makes it very
+easy to include example HTML source code using Markdown \-\- just paste
+it and indent it, and Markdown will handle the hassle of encoding the
+ampersands and angle brackets. For example, this:
+.
+.IP "" 4
+.
+.nf
+    <div class="footer">
+        &copy; 2004 Foo Corporation
+    </div>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will turn into:
+.
+.IP "" 4
+.
+.nf
+<pre><code>&lt;div class="footer"&gt;
+    &amp;copy; 2004 Foo Corporation
+&lt;/div&gt;
+</code></pre>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Regular Markdown syntax is not processed within code blocks. E.g.,
+asterisks are just literal asterisks within a code block. This means
+it's also easy to use Markdown to write about Markdown's own syntax.
+.
+.SS "Horizontal Rules"
+You can produce a horizontal rule tag (\fB<hr />\fR) by placing three or
+more hyphens, asterisks, or underscores on a line by themselves. If you
+wish, you may use spaces between the hyphens or asterisks. Each of the
+following lines will produce a horizontal rule:
+.
+.IP "" 4
+.
+.nf
+* * *
+***
+*****
+\- \- \-
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SPAN ELEMENTS"
+.
+.SS "Links"
+Markdown supports two style of links: \fIinline\fR and \fIreference\fR.
+.
+.P
+In both styles, the link text is delimited by [square brackets].
+.
+.P
+To create an inline link, use a set of regular parentheses immediately
+after the link text's closing square bracket. Inside the parentheses,
+put the URL where you want the link to point, along with an \fIoptional\fR
+title for the link, surrounded in quotes. For example:
+.
+.IP "" 4
+.
+.nf
+This is [an example](http://example.com/ "Title") inline link.
+[This link](http://example.net/) has no title attribute.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Will produce:
+.
+.IP "" 4
+.
+.nf
+<p>This is <a href="http://example.com/" title="Title">
+an example</a> inline link.</p>
+<p><a href="http://example.net/">This link</a> has no
+title attribute.</p>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+If you're referring to a local resource on the same server, you can
+use relative paths:
+.
+.IP "" 4
+.
+.nf
+See my [About](/about/) page for details.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Reference\-style links use a second set of square brackets, inside
+which you place a label of your choosing to identify the link:
+.
+.IP "" 4
+.
+.nf
+This is [an example][id] reference\-style link.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+You can optionally use a space to separate the sets of brackets:
+.
+.IP "" 4
+.
+.nf
+This is [an example] [id] reference\-style link.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Then, anywhere in the document, you define your link label like this,
+on a line by itself:
+.
+.IP "" 4
+.
+.nf
+[id]: http://example.com/  "Optional Title Here"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+That is:
+.
+.IP "\(bu" 4
+Square brackets containing the link identifier (optionally
+indented from the left margin using up to three spaces);
+.
+.IP "\(bu" 4
+followed by a colon;
+.
+.IP "\(bu" 4
+followed by one or more spaces (or tabs);
+.
+.IP "\(bu" 4
+followed by the URL for the link;
+.
+.IP "\(bu" 4
+optionally followed by a title attribute for the link, enclosed
+in double or single quotes, or enclosed in parentheses.
+.
+.IP "" 0
+.
+.P
+The following three link definitions are equivalent:
+.
+.IP "" 4
+.
+.nf
+[foo]: http://example.com/  "Optional Title Here"
+[foo]: http://example.com/  'Optional Title Here'
+[foo]: http://example.com/  (Optional Title Here)
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fBNote:\fR There is a known bug in Markdown.pl 1.0.1 which prevents
+single quotes from being used to delimit link titles.
+.
+.P
+The link URL may, optionally, be surrounded by angle brackets:
+.
+.IP "" 4
+.
+.nf
+[id]: <http://example.com/>  "Optional Title Here"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+You can put the title attribute on the next line and use extra spaces
+or tabs for padding, which tends to look better with longer URLs:
+.
+.IP "" 4
+.
+.nf
+[id]: http://example.com/longish/path/to/resource/here
+    "Optional Title Here"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Link definitions are only used for creating links during Markdown
+processing, and are stripped from your document in the HTML output.
+.
+.P
+Link definition names may consist of letters, numbers, spaces, and
+punctuation \-\- but they are \fInot\fR case sensitive. E.g. these two
+links:
+.
+.IP "" 4
+.
+.nf
+[link text][a]
+[link text][A]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+are equivalent.
+.
+.P
+The \fIimplicit link name\fR shortcut allows you to omit the name of the
+link, in which case the link text itself is used as the name.
+Just use an empty set of square brackets \-\- e.g., to link the word
+"Google" to the google.com web site, you could simply write:
+.
+.IP "" 4
+.
+.nf
+[Google][]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+And then define the link:
+.
+.IP "" 4
+.
+.nf
+[Google]: http://google.com/
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Because link names may contain spaces, this shortcut even works for
+multiple words in the link text:
+.
+.IP "" 4
+.
+.nf
+Visit [Daring Fireball][] for more information.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+And then define the link:
+.
+.IP "" 4
+.
+.nf
+[Daring Fireball]: http://daringfireball.net/
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Link definitions can be placed anywhere in your Markdown document. I
+tend to put them immediately after each paragraph in which they're
+used, but if you want, you can put them all at the end of your
+document, sort of like footnotes.
+.
+.P
+Here's an example of reference links in action:
+.
+.IP "" 4
+.
+.nf
+I get 10 times more traffic from [Google] [1] than from
+[Yahoo] [2] or [MSN] [3].
+  [1]: http://google.com/        "Google"
+  [2]: http://search.yahoo.com/  "Yahoo Search"
+  [3]: http://search.msn.com/    "MSN Search"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Using the implicit link name shortcut, you could instead write:
+.
+.IP "" 4
+.
+.nf
+I get 10 times more traffic from [Google][] than from
+[Yahoo][] or [MSN][].
+  [google]: http://google.com/        "Google"
+  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
+  [msn]:    http://search.msn.com/    "MSN Search"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Both of the above examples will produce the following HTML output:
+.
+.IP "" 4
+.
+.nf
+<p>I get 10 times more traffic from <a href="http://google.com/"
+title="Google">Google</a> than from
+<a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>
+or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+For comparison, here is the same paragraph written using
+Markdown's inline link style:
+.
+.IP "" 4
+.
+.nf
+I get 10 times more traffic from [Google](http://google.com/ "Google")
+than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
+[MSN](http://search.msn.com/ "MSN Search").
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The point of reference\-style links is not that they're easier to
+write. The point is that with reference\-style links, your document
+source is vastly more readable. Compare the above examples: using
+reference\-style links, the paragraph itself is only 81 characters
+long; with inline\-style links, it's 176 characters; and as raw HTML,
+it's 234 characters. In the raw HTML, there's more markup than there
+is text.
+.
+.P
+With Markdown's reference\-style links, a source document much more
+closely resembles the final output, as rendered in a browser. By
+allowing you to move the markup\-related metadata out of the paragraph,
+you can add links without interrupting the narrative flow of your
+prose.
+.
+.SS "Emphasis"
+Markdown treats asterisks (\fB*\fR) and underscores (\fB_\fR) as indicators of
+emphasis. Text wrapped with one \fB*\fR or \fB_\fR will be wrapped with an
+HTML \fB<em>\fR tag; double \fB*\fR's or \fB_\fR's will be wrapped with an HTML \fB<strong>\fR tag. E.g., this input:
+.
+.IP "" 4
+.
+.nf
+*single asterisks*
+_single underscores_
+**double asterisks**
+__double underscores__
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will produce:
+.
+.IP "" 4
+.
+.nf
+<em>single asterisks</em>
+<em>single underscores</em>
+<strong>double asterisks</strong>
+<strong>double underscores</strong>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+You can use whichever style you prefer; the lone restriction is that
+the same character must be used to open and close an emphasis span.
+.
+.P
+Emphasis can be used in the middle of a word:
+.
+.IP "" 4
+.
+.nf
+un*frigging*believable
+.
+.fi
+.
+.IP "" 0
+.
+.P
+But if you surround an \fB*\fR or \fB_\fR with spaces, it'll be treated as a
+literal asterisk or underscore.
+.
+.P
+To produce a literal asterisk or underscore at a position where it
+would otherwise be used as an emphasis delimiter, you can backslash
+escape it:
+.
+.IP "" 4
+.
+.nf
+\\*this text is surrounded by literal asterisks\\*
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Code"
+To indicate a span of code, wrap it with backtick quotes (\fB`\fR).
+Unlike a pre\-formatted code block, a code span indicates code within a
+normal paragraph. For example:
+.
+.IP "" 4
+.
+.nf
+Use the `printf()` function.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will produce:
+.
+.IP "" 4
+.
+.nf
+<p>Use the <code>printf()</code> function.</p>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To include a literal backtick character within a code span, you can use
+multiple backticks as the opening and closing delimiters:
+.
+.IP "" 4
+.
+.nf
+``There is a literal backtick (`) here.``
+.
+.fi
+.
+.IP "" 0
+.
+.P
+which will produce this:
+.
+.IP "" 4
+.
+.nf
+<p><code>There is a literal backtick (`) here.</code></p>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The backtick delimiters surrounding a code span may include spaces \-\-
+one after the opening, one before the closing. This allows you to place
+literal backtick characters at the beginning or end of a code span:
+.
+.IP "" 4
+.
+.nf
+A single backtick in a code span: `` ` ``
+A backtick\-delimited string in a code span: `` `foo` ``
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will produce:
+.
+.IP "" 4
+.
+.nf
+<p>A single backtick in a code span: <code>`</code></p>
+<p>A backtick\-delimited string in a code span: <code>`foo`</code></p>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+With a code span, ampersands and angle brackets are encoded as HTML
+entities automatically, which makes it easy to include example HTML
+tags. Markdown will turn this:
+.
+.IP "" 4
+.
+.nf
+Please don't use any `<blink>` tags.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+into:
+.
+.IP "" 4
+.
+.nf
+<p>Please don't use any <code>&lt;blink&gt;</code> tags.</p>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+You can write this:
+.
+.IP "" 4
+.
+.nf
+`&#8212;` is the decimal\-encoded equivalent of `&mdash;`.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+to produce:
+.
+.IP "" 4
+.
+.nf
+<p><code>&amp;#8212;</code> is the decimal\-encoded
+equivalent of <code>&amp;mdash;</code>.</p>
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Images"
+Admittedly, it's fairly difficult to devise a "natural" syntax for
+placing images into a plain text document format.
+.
+.P
+Markdown uses an image syntax that is intended to resemble the syntax
+for links, allowing for two styles: \fIinline\fR and \fIreference\fR.
+.
+.P
+Inline image syntax looks like this:
+.
+.IP "" 4
+.
+.nf
+![Alt text](/path/to/img.jpg)
+![Alt text](/path/to/img.jpg "Optional title")
+.
+.fi
+.
+.IP "" 0
+.
+.P
+That is:
+.
+.IP "\(bu" 4
+An exclamation mark: \fB!\fR;
+.
+.IP "\(bu" 4
+followed by a set of square brackets, containing the \fBalt\fR
+attribute text for the image;
+.
+.IP "\(bu" 4
+followed by a set of parentheses, containing the URL or path to
+the image, and an optional \fBtitle\fR attribute enclosed in double
+or single quotes.
+.
+.IP "" 0
+.
+.P
+Reference\-style image syntax looks like this:
+.
+.IP "" 4
+.
+.nf
+![Alt text][id]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Where "id" is the name of a defined image reference. Image references
+are defined using syntax identical to link references:
+.
+.IP "" 4
+.
+.nf
+[id]: url/to/image  "Optional title attribute"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+As of this writing, Markdown has no syntax for specifying the
+dimensions of an image; if this is important to you, you can simply
+use regular HTML \fB<img>\fR tags.
+.
+.SH "MISCELLANEOUS"
+.
+.SS "Automatic Links"
+Markdown supports a shortcut style for creating "automatic" links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:
+.
+.IP "" 4
+.
+.nf
+<http://example.com/>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Markdown will turn this into:
+.
+.IP "" 4
+.
+.nf
+<a href="http://example.com/">http://example.com/</a>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Automatic links for email addresses work similarly, except that
+Markdown will also perform a bit of randomized decimal and hex
+entity\-encoding to help obscure your address from address\-harvesting
+spambots. For example, Markdown will turn this:
+.
+.IP "" 4
+.
+.nf
+<address@example.com>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+into something like this:
+.
+.IP "" 4
+.
+.nf
+<a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65;
+&#115;&#115;&#64;&#101;&#120;&#x61;&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;
+&#109;">&#x61;&#x64;&#x64;&#x72;&#x65;&#115;&#115;&#64;&#101;&#120;&#x61;
+&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;&#109;</a>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+which will render in a browser as a clickable link to "address@example.com".
+.
+.P
+(This sort of entity\-encoding trick will indeed fool many, if not
+most, address\-harvesting bots, but it definitely won't fool all of
+them. It's better than nothing, but an address published in this way
+will probably eventually start receiving spam.)
+.
+.SS "Backslash Escapes"
+Markdown allows you to use backslash escapes to generate literal
+characters which would otherwise have special meaning in Markdown's
+formatting syntax. For example, if you wanted to surround a word
+with literal asterisks (instead of an HTML \fB<em>\fR tag), you can use
+backslashes before the asterisks, like this:
+.
+.IP "" 4
+.
+.nf
+\\*literal asterisks\\*
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Markdown provides backslash escapes for the following characters:
+.
+.IP "" 4
+.
+.nf
+\\   backslash
+`   backtick
+*   asterisk
+_   underscore
+{}  curly braces
+[]  square brackets
+()  parentheses
+#   hash mark
++   plus sign
+\-   minus sign (hyphen)
+.   dot
+!   exclamation mark
+.
+.fi
+.
+.IP "" 0
+.
+.SH "AUTHOR"
+Markdown was created by John Gruber.
+.
+.P
+Manual page by Ryan Tomayko. It's pretty much a direct copy of the\fIMarkdown Syntax Reference\fR,
+also by John Gruber.
+.
+.SH "SEE ALSO"
+ronn(5)
+.
+.br
+\fIhttp://daringfireball.net/projects/markdown/\fR