-`--listings` option is used), `fancyvrb`, `longtable`, `url`,

- memoir class, this option is implied. If `--beamer` is used,

- top-level headers will become `\part{..}`.

- that the image be less than 1000px in width and height.

- + brocolli

-literally). (Techncially this is not an extension, since standard

-See the MultiMarkdown documentation for details. Note that only title,

-author, and date are recognized; other fields are simply ignored by

-pandoc. If `pandoc_title_block` or `yaml_metadata_block` is enabled,

-it will take precedence over `mmd_title_block`.

-format (`markdown`, `mardkown_strict`, `rst`, or `latex` for input or output;

-

-- Add release on github

- * Fixed uniqueIdent in Shared so that header identifiers work as

-Subproject 4bdebc73b0b2025cf01704e7e564088c34d8f86

-googlecode_upload.py -s "Mac OS X installer" -p pandoc -u fiddlosopher --labels=Featured,Type-Installer,OpSys-OSX pandoc-$VERSION.dmg

-#!/bin/sh -e

-ME=jgm

-EXES="pandoc pandoc-citeproc biblio2yaml"

-echo Creating disk image...

-sudo hdiutil create "$BASE.dmg" \

- -format UDZO -ov \

- -volname "pandoc $VERSION" \

- -srcfolder $BASE.pkg

-sudo hdiutil internet-enable "$BASE.dmg"

-Version: 1.12.2

- array >= 0.3 && < 0.5,

- process >= 1 && < 1.2,

- text >= 0.11 && < 0.12,

- zip-archive >= 0.1.3.3 && < 0.2,

- texmath >= 0.6.5.2 && < 0.7,

- aeson >= 0.6 && < 0.7,

- highlighting-kate >= 0.5.5 && < 0.6,

- temporary >= 1.1 && < 1.2,

- blaze-html >= 0.5 && < 0.7,

- blaze-markup >= 0.5.1 && < 0.6,

- attoparsec >= 0.10 && < 0.11,

- hslua >= 0.3 && < 0.4

- Build-Depends: http-conduit >= 1.9 && < 1.10,

- text >= 0.11 && < 0.12,

- highlighting-kate >= 0.5.5 && < 0.6,

- aeson >= 0.6 && < 0.7,

- text >= 0.11 && < 0.12,

- text >= 0.11 && < 0.12,

- process >= 1 && < 1.2,

- highlighting-kate >= 0.5.5 && < 0.6,

- safeRead, headerShift, normalize, err, warn )

-import Network.HTTP (simpleHTTP, mkRequest, getResponseBody, RequestMethod(..))

- if (b == "pdflatex" || b == "lualatex" || b == "xelatex")

- Just _ | all (\f -> takeBaseName f /= "pandoc-citeproc")

- else writerName

- s <- readDataFileUTF8 datadir

- ("LaTeXMathML.js")

- s <- readDataFileUTF8 datadir

- ("MathMLinHTML.js")

- readURI u

- readURI uri = simpleHTTP (mkRequest GET uri) >>= getResponseBody >>=

- return . UTF8.toStringLazy -- treat all as UTF8

-getDefaultExtensions _ = pandocExtensions

- "\xff\xd8\xff\xe0" -> return Jpeg

- guard $ hdr == "\xff\xd8\xff\xe0"

- (w,h) <- findJpegSize rest

-findJpegSize :: ByteString -> Maybe (Integer,Integer)

-findJpegSize bs = do

- findJpegSize $ B.drop len bs''

-extensionFromMimeType mimetype = M.lookup mimetype reverseMimeTypes

- let ext = maybe (takeExtension src) id $

-{-# LANGUAGE GeneralizedNewtypeDeriving #-}

-nonspaceChar = satisfy $ \x -> x /= '\t' && x /= '\n' && x /= ' ' && x /= '\r'

-registerHeader :: Attr -> Inlines -> Parser s ParserState Attr

- ids <- stateIdentifiers `fmap` getState

- exts <- getOption readerExtensions

- updateState $ \st -> st{

- stateIdentifiers = if id' == id''

- then id' : ids

- else id' : id'' : ids,

- stateHeaders = insert' header' id' $ stateHeaders st }

- unless (null ident) $

- updateState $ \st -> st{

- stateHeaders = insert' header' ident $ stateHeaders st }

- notFollowedBy (satisfy (\c -> c == ' ' || c == '\t' || c == '\n'))

-import Data.Sequence (Seq, fromList, (<|), singleton, mapWithIndex)

-data Monoid a =>

- RenderState a = RenderState{

- let start = maybe 1 id $

- let e' = maybe e id $ filterChild (named "tgroup") e

- Just w -> maybe 0 id

- let numrows = maximum $ map length bodyrows

-pHead = pInTags "head" $ pTitle <|> ([] <$ pAnyTag)

- let ident = maybe "" id $ lookup "id" attr

- maybe 0.0 id $ safeRead ('0':'.':init x)

- pStr <|> pSpace <|> smartPunctuation pTagContents <|> pSymbol <|> pBad

- "th", "thead", "tr", "script", "style", "video"]

-import Text.Pandoc.Parsing hiding ((<|>), many, optional, space)

-double_quote = (doubleQuoted . mconcat) <$>

- (try $ string "``" *> manyTill inline (try $ string "''"))

-single_quote = (singleQuoted . mconcat) <$>

- (try $ char '`' *> manyTill inline (try $ char '\'' >> notFollowedBy letter))

- <|> (str "“" <$ try (string "``")) -- nb. {``} won't be caught by double_quote

- <|> (str "‘" <$ char '`') -- nb. {`} won't be caught by single_quote

-inlineChar = noneOf "\\$%^_&~#{}^'`-[] \t\n"

- guard $ name == "verbatim" || name == "Verbatim" ||

- name == "lstlisting" || name == "minted" ||

- name == "alltt"

- ( if B.isNull title' then id else B.setMeta "title" title'

- . if null author' then id else B.setMeta "author" author'

- . if B.isNull date' then id else B.setMeta "date" date' )

- nullMeta

- many (spaceChar)

- chunks <- manyTill (liftM snd (htmlTag isCommentTag) <|> count 1 anyChar) newline

- unless ((style == DefaultStyle || style == Decimal || style == Example) &&

- (delim == DefaultDelim || delim == Period)) $

-htmlElement = strictHtmlBlock <|> liftM snd (htmlTag isBlockTag)

- (TagOpen tag _, open) <- htmlTag (tagOpen (\t ->

- t == "pre" || t == "style" || t == "script")

- (\ln -> tail $ splitStringByIndices (init indices) ln)

- else map unwords rawHeadsList

- else map unwords $ transpose

-mathDisplay :: MarkdownParser String

-mathDisplay =

- (guardEnabled Ext_tex_math_dollars >> mathDisplayWith "$$" "$$")

- <|> (guardEnabled Ext_tex_math_single_backslash >>

- mathDisplayWith "\\[" "\\]")

- <|> (guardEnabled Ext_tex_math_double_backslash >>

- mathDisplayWith "\\\\[" "\\\\]")

-

-mathDisplayWith :: String -> String -> MarkdownParser String

-mathDisplayWith op cl = try $ do

- string op

- many1Till (noneOf "\n" <|> (newline >>~ notFollowedBy' blankline)) (try $ string cl)

-

-mathInline :: MarkdownParser String

-mathInline =

- (guardEnabled Ext_tex_math_dollars >> mathInlineWith "$" "$")

- <|> (guardEnabled Ext_tex_math_single_backslash >>

- mathInlineWith "\\(" "\\)")

- <|> (guardEnabled Ext_tex_math_double_backslash >>

- mathInlineWith "\\\\(" "\\\\)")

-

-mathInlineWith :: String -> String -> MarkdownParser String

-mathInlineWith op cl = try $ do

- string op

- notFollowedBy space

- words' <- many1Till (count 1 (noneOf "\n\\")

- <|> (char '\\' >> anyChar >>= \c -> return ['\\',c])

- <|> count 1 newline <* notFollowedBy' blankline

- *> return " ")

- (try $ string cl)

- notFollowedBy digit -- to prevent capture of $5

- return $ concat words'

-

- two c prefix') )

- -- parse potential list-starts differently if in a list:

- st <- getState

- when (stateParserContext st == ListItemState) $ do

- notFollowedBy' bulletListStart

- notFollowedBy' anyOrderedListStart

- let ident = maybe "" id $ lookup "id" attrs

- let ident = maybe "" id $ lookup "id" attrs

- first <- letter

- let internal p = try $ p >>~ lookAhead (letter <|> digit)

- rest <- many $ letter <|> digit <|> internal (oneOf ":.#$%&-_+?<>~/")

-{-# LANGUAGE RelaxedPolyRec #-} -- needed for inlinesBetween on GHC < 7

- else mconcat <$> manyTill block (htmlTag (~== TagClose tag))

- Just w -> maybe 1.0 id $ parseWidth w

- Just xs -> maybe 0.0 id $ parseWidth xs

- return $ B.header lev contents

- <|> (B.orderedList <$> (htmlTag (~== TagOpen "ul" []) *> spaces *>

- many (listItem '#' <|> li) <*

- optional (htmlTag (~== TagClose "ul"))))

- <|> do (tag,_) <- htmlTag (~== TagOpen "ol" [])

- spaces

- items <- many (listItem '#' <|> li)

- optional (htmlTag (~== TagClose "ol"))

- let start = maybe 1 id $ safeRead $ fromAttrib "start" tag

- return $ B.orderedListWith (start, DefaultStyle, DefaultDelim) items

- lns <- many1 birdTrackLine

- -- if (as is normal) there is always a space after >, drop it

- let lns' = if all (\ln -> null ln || take 1 ln == " ") lns

- then map (drop 1) lns

- else lns

- $ intercalate "\n" lns'

-simpleInline border construct = surrounded border (inlineWithAttribute) >>=

-import Network.URI ( escapeURIString, isURI, unEscapeString )

- "%d %B %Y", "%b. %d, %Y", "%B %d, %Y"]

-isTightList = and . map firstIsPlain

- renderOptions{ optMinimize = \x ->

- let y = map toLower x

- in y == "hr" || y == "br" ||

- y == "img" || y == "meta" ||

- y == "link"

- , optRawTag = \x ->

- let y = map toLower x

- in y == "script" || y == "style" }

- | otherwise = case sourceURL of

- Just u -> openURL (u ++ "/" ++ s)

- Nothing -> E.try readLocalFile

- in return $ Right (contents, Just mime)

- | otherwise = E.try $ do

- return $ blankline $$ "\\placefigure[here,nonumber]" <> braces capt <>

- return $ "\\placetable" <> brackets ("here" <> if null caption

- then ",none"

- else "")

- (Just . render colwidth . blocksToDocbook opts)

- (Just . render colwidth . inlinesToDocbook opts)

-import Data.List ( intercalate, groupBy )

-import System.FilePath (takeExtension)

-import Text.Pandoc.MIME (getMimeType)

- mkOverrideNode ("/word/" ++ imgpath, maybe "application/octet-stream" id mbMimeType)

- : mknode "dcterms:created" [("xsi:type","dcterms:W3CDTF")]

- (maybe "" id $ normalizeDate $ stringify $ docDate meta)

- : mknode "dcterms:modified" [("xsi:type","dcterms:W3CDTF")] () -- put current time here

- : map (mknode "dc:creator" [] . stringify) (docAuthors meta)

- ,("Type","http://schemas.openxmlformats.org/officedocument/2006/relationships/metadata/core-properties")

- imageEntries

- where absnumid = maybe 0 id $ M.lookup marker markers

-inlineToOpenXML opts (Span _ ils) = inlinesToOpenXML opts ils

- Right (img, _) -> do

- let imgext = case imageType img of

- Just Png -> ".png"

- Just Jpeg -> ".jpeg"

- Just Gif -> ".gif"

- Just Pdf -> ".pdf"

- Just Eps -> ".eps"

- Nothing -> takeExtension src

- let mbMimeType = getMimeType imgpath

- case (findEntryByPath relpath refArchive >>= parseXMLDoc . UTF8.toStringLazy . fromEntry) of

- Just d -> return d

-

-isDisplayMath :: Inline -> Bool

-isDisplayMath (Math DisplayMath _) = True

-isDisplayMath _ = False

-

-stripLeadingTrailingSpace :: [Inline] -> [Inline]

-stripLeadingTrailingSpace = go . reverse . go . reverse

- where go (Space:xs) = xs

- go xs = xs

-

-fixDisplayMath :: Block -> Block

-fixDisplayMath (Plain lst)

- | any isDisplayMath lst && not (all isDisplayMath lst) =

- -- chop into several paragraphs so each displaymath is its own

- Div ("",["math"],[]) $ map (Plain . stripLeadingTrailingSpace) $

- groupBy (\x y -> (isDisplayMath x && isDisplayMath y) ||

- not (isDisplayMath x || isDisplayMath y)) lst

-fixDisplayMath (Para lst)

- | any isDisplayMath lst && not (all isDisplayMath lst) =

- -- chop into several paragraphs so each displaymath is its own

- Div ("",["math"],[]) $ map (Para . stripLeadingTrailingSpace) $

- groupBy (\x y -> (isDisplayMath x && isDisplayMath y) ||

- not (isDisplayMath x || isDisplayMath y)) lst

-fixDisplayMath x = x

-{-# LANGUAGE PatternGuards, CPP #-}

-import Data.Maybe ( fromMaybe, isNothing )

-import Text.Pandoc.UTF8 ( fromStringLazy, toString )

-import Data.Char ( toLower )

- let version = maybe EPUB2 id (writerEpubVersion opts)

- let mbCoverImage = lookup "epub-cover-image" vars

- case mbCoverImage of

- maybe [] id mbnum }

- Pandoc (setMeta "title" (fromList xs) nullMeta) bs

- let containsMathML ent = "<math" `isInfixOf` (B8.unpack $ fromEntry ent)

- localeLang <- catch (liftM (map (\c -> if c == '_' then '-' else c) .

- takeWhile (/='.')) $ getEnv "LANG")

- (\e -> let _ = (e :: SomeException) in return "en-US")

- let lang = case lookup "lang" (writerVariables opts') of

- Just x -> x

- Nothing -> localeLang

- uuid <- getRandomUUID

- ++ [("properties","mathml") | epub3 &&

- containsMathML ent]) $ ()

- ("media-type", maybe "" id $ getMimeType $ eRelativePath ent)] $ ()

- let plainify t = trimr $

- writePlain opts'{ writerStandalone = False } $

- Pandoc meta [Plain t]

- let plainTitle = plainify $ docTitle meta

- let plainAuthors = map plainify $ docAuthors meta

- let plainDate = maybe (showDateTimeISO8601 currentTime) id

- $ normalizeDate $ stringify $ docDate meta

- let contentsData = fromStringLazy $ ppTopElement $

- ,("unique-identifier","BookId")] $

- [ metadataElement version (writerEpubMetadata opts')

- uuid lang plainTitle plainAuthors plainDate currentTime mbCoverImage

- map pictureNode (cpicEntry ++ picEntries) ++

- case mbCoverImage of

- unode "reference" !

- [("type","toc"),("title",plainTitle),("href","nav.xhtml")] $ ()

- let tocData = fromStringLazy $ ppTopElement $

- ,("content", show uuid)] $ ()

- ] ++ case mbCoverImage of

- let navData = fromStringLazy $ ppTopElement $

- let mimetypeEntry = mkEntry "mimetype" $ fromStringLazy "application/epub+zip"

- let containerData = fromStringLazy $ ppTopElement $

- let apple = fromStringLazy $ ppTopElement $

- stylesheet <- case writerEpubStylesheet opts of

- Just s -> return s

- Nothing -> toString `fmap`

- let stylesheetEntry = mkEntry "stylesheet.css" $ fromStringLazy stylesheet

-metadataElement :: EPUBVersion -> String -> UUID -> String -> String -> [String]

- -> String -> UTCTime -> Maybe a -> Element

-metadataElement version metadataXML uuid lang title authors date currentTime mbCoverImage =

- let userNodes = parseXML metadataXML

- elt = unode "metadata" ! [("xmlns:dc","http://purl.org/dc/elements/1.1/")

- ,("xmlns:opf","http://www.idpf.org/2007/opf")] $

- filter isMetadataElement $ onlyElems userNodes

- dublinElements = ["contributor","coverage","creator","date",

- "description","format","identifier","language","publisher",

- "relation","rights","source","subject","title","type"]

- isMetadataElement e = (qPrefix (elName e) == Just "dc" &&

- qName (elName e) `elem` dublinElements) ||

- (qPrefix (elName e) == Nothing &&

- qName (elName e) `elem` ["link","meta"])

- contains e n = not (null (findElements (QName n Nothing (Just "dc")) e))

- newNodes = [ unode "dc:title" title | not (elt `contains` "title") ] ++

- [ unode "dc:language" lang | not (elt `contains` "language") ] ++

- [ unode "dc:identifier" ! [("id","BookId")] $ show uuid |

- not (elt `contains` "identifier") ] ++

- [ unode "dc:creator" ! [("opf:role","aut") | version == EPUB2]

- $ a | a <- authors, not (elt `contains` "creator") ] ++

- [ unode "dc:date" date | not (elt `contains` "date") ] ++

- [ unode "meta" ! [("property", "dcterms:modified")] $

- (showDateTimeISO8601 currentTime) | version == EPUB3] ++

- [ unode "meta" ! [("name","cover"), ("content","cover-image")] $ () |

- not (isNothing mbCoverImage) ]

- in elt{ elContent = elContent elt ++ map Elem newNodes }

-imageTypeOf x = case drop 1 (map toLower (takeExtension x)) of

- "jpg" -> Just "image/jpeg"

- "jpeg" -> Just "image/jpeg"

- "jfif" -> Just "image/jpeg"

- "png" -> Just "image/png"

- "gif" -> Just "image/gif"

- "svg" -> Just "image/svg+xml"

- _ -> Nothing

-

-import Text.Pandoc.Shared (orderedListMarkers)

- hasSubsections = any isHeader

- isHeader (Header _ _ _) = True

- isHeader _ = False

-import Data.Maybe ( catMaybes )

- let slideLevel = maybe (getSlideLevel blocks) id $ writerSlideLevel opts

-blockToHtml opts (Header level (ident,_,_) lst) = do

- let revealSlash = ['/' | writerSlideVariant opts == RevealJsSlides]

- let contents'' = if writerTableOfContents opts && not (null ident)

- then H.a ! A.href (toValue $

- '#' : revealSlash ++

- writerIdentifierPrefix opts ++

- ident) $ contents'

- else contents'

- 1 -> H.h1 contents''

- 2 -> H.h2 contents''

- 3 -> H.h3 contents''

- 4 -> H.h4 contents''

- 5 -> H.h5 contents''

- 6 -> H.h6 contents''

- _ -> H.p contents''

- else liftM (H.dt) $ inlineListToHtml opts term

- (Span attr ils) -> inlineListToHtml opts ils >>=

- return . addAttrs opts attr . H.span

- (Note contents) -> do

- let link' = case writerEpubVersion opts of

- Just EPUB3 -> link ! customAttribute "epub:type" "noteref"

- _ -> link

- return $ H.sup $ link'

- WriterState { stInNote = False,

- defField "title-meta" (stringify $ docTitle meta) $

- defField "author-meta" (intercalate "; " $ map stringify $ docAuthors meta) $

- let ligatures = writerTeXLigatures opts && not (ctx == CodeString)

- let slideLevel = maybe (getSlideLevel bs) id $ writerSlideLevel opts

- let spacing = if and $ map isTightList (map snd lst)

- else ($$ "\\hline\\noalign{\\medskip}") `fmap`

- else text "\\noalign{\\medskip}"

- $$ "\\hline\\noalign{\\medskip}"

- $$ "\\hline"

- renderedCells <- mapM blockListToLaTeX cols

- let valign = text $ if header then "[b]" else "[t]"

- let halign x = case x of

- AlignLeft -> "\\raggedright"

- AlignRight -> "\\raggedleft"

- AlignCenter -> "\\centering"

- AlignDefault -> "\\raggedright"

- let toCell 0 _ c = c

- toCell w a c = "\\begin{minipage}" <> valign <>

- braces (text (printf "%.2f\\columnwidth"

- (w * scaleFactor))) <>

- (halign a <> cr <> c <> cr) <> "\\end{minipage}"

- let cells = zipWith3 toCell widths aligns renderedCells

- return $ hsep (intersperse "&" cells) $$ "\\\\\\noalign{\\medskip}"

-inlineToLaTeX (Span _ ils) = inlineListToLaTeX ils >>= return . braces

- return $ "\\footnote" <> braces (nest 2 contents' <> optnl)

- -- note: a \n before } needed when note ends with a Verbatim environment

- noPrefix = and . map (null . citationPrefix)

- noSuffix = and . map (null . citationSuffix)

- ismode m = and . map (((==) m) . citationMode)

- | f == "latex" || f == "tex" || f == "markdown" = do

- case attribs of

- x | x /= nullAttr && isEnabled Ext_fenced_code_blocks opts ->

- tildes <> " " <> attrs <> cr <> text str <>

- cr <> tildes <> blankline

- (_,(cls:_),_) | isEnabled Ext_backtick_code_blocks opts ->

- backticks <> " " <> text cls <> cr <> text str <>

- cr <> backticks <> blankline

- then nowrap $ attrsToMarkdown attribs

- else empty

- return $ hang (writerTabStop opts) start $ contents <> cr

- case find (\n -> not (any (== [Str (show n)])

- (map fst (stRefs st)))) [1..(10000 :: Integer)] of

- Just x -> [Str (show x)]

- Nothing -> error "no unique label"

- (WriterState { stNotes = False, stListLevel = [], stUseTags = False })

-import Data.List ( isPrefixOf )

-import System.FilePath ( takeExtension )

- -- handle pictures

- doc' <- walkM (transformPic opts picEntriesRef) doc

- Nothing -> empty

-transformPic :: WriterOptions -> IORef [Entry] -> Inline -> IO Inline

-transformPic opts entriesRef (Image lab (src,_)) = do

- let (w,h) = maybe (0,0) id $ sizeInPoints `fmap` size

-transformPic _ _ x = return x

- | Plain b <- bs = inParagraphTags =<< inlinesToOpenDocument o b

- | Para b <- bs = inParagraphTags =<< inlinesToOpenDocument o b

- | RawBlock f s <- bs = if f == "opendocument"

- then preformatted s

- | RawInline f s <- ils = if f == "opendocument" || f == "html"

- then withTextStyle Pre $ inTextStyle $ preformatted s

- | Image _ (s,t) <- ils = return $ mkImg s t

- mkImg s t = inTags False "draw:frame" (attrsFromTitle t) $

-blockToOrg (RawBlock f str) | f == "org" || f == "latex" || f == "tex" =

- return $ label' $$ nest tabstop (contents <> cr)

- return $ M.foldWithKey (\key val obj -> defField key val obj)

- baseContext renderedMap

- let (before, after) = break isHeader xs

-isHeader :: Block -> Bool

-isHeader (Header _ _ _) = True

-isHeader _ = False

-

- (WriterState { stNotes = [], stListLevel = [], stUseTags = False })

-#!/usr/bin/perl

-

-#

-# MarkdownTester -- Run tests for Markdown implementations

-#

-# Copyright (c) 2004-2005 John Gruber

-# <http://daringfireball.net/projects/markdown/>

-#

-

-use strict;

-use warnings;

-use Getopt::Long;

-use Benchmark;

-

-our $VERSION = '1.0.2';

-# Sat 24 Dec 2005

-

-my $time_start = new Benchmark;

-my $test_dir = "Tests";

-my $script = "./Markdown.pl";

-my $use_tidy = 0;

-my ($flag_version);

-

-GetOptions (

- "script=s" => \$script,

- "testdir=s" => \$test_dir,

- "tidy" => \$use_tidy,

- "version" => \$flag_version,

- );

-

-if($flag_version) {

- my $progname = $0;

- $progname =~ s{.*/}{};

- die "$progname version $VERSION\n";

-}

-

-unless (-d $test_dir) { die "'$test_dir' is not a directory.\n"; }

-unless (-f $script) { die "$script does not exist.\n"; }

-unless (-x $script) { die "$script is not executable.\n"; }

-

-my $tests_passed = 0;

-my $tests_failed = 0;

-

-TEST:

-foreach my $testfile (glob "$test_dir/*.text") {

- my $testname = $testfile;

- $testname =~ s{.*/(.+)\.text$}{$1}i;

- print "$testname ... ";

-

- # Look for a corresponding .html file for each .text file:

- my $resultfile = $testfile;

- $resultfile =~ s{\.text$}{\.html}i;

- unless (-f $resultfile) {

- print "'$resultfile' does not exist.\n\n";

- next TEST;

- }

-

- # open(TEST, $testfile) || die("Can't open testfile: $!");

- open(RESULT, $resultfile) || die("Can't open resultfile: $!");

- undef $/;

- # my $t_input = <TEST>;

- my $t_result = <RESULT>;

-

- my $t_output = `'$script' '$testfile'`;

-

- # Normalize the output and expected result strings:

- $t_result =~ s/\s+\z//; # trim trailing whitespace

- $t_output =~ s/\s+\z//; # trim trailing whitespace

- if ($use_tidy) {

- # Escape the strings, pass them through to CLI tidy tool for tag-level equivalency

- $t_result =~ s{'}{'\\''}g; # escape ' chars for shell

- $t_output =~ s{'}{'\\''}g;

- $t_result = `echo '$t_result' | tidy --show-body-only 1 --quiet 1 --show-warnings 0`;

- $t_output = `echo '$t_output' | tidy --show-body-only 1 --quiet 1 --show-warnings 0`;

- }

-

- if ($t_output eq $t_result) {

- print "OK\n";

- $tests_passed++;

- }

- else {

- print "FAILED\n\n";

-# This part added by JM to print diffs

- open(OUT, '>tmp1') or die $!;

- print OUT $t_output or die $!;

- open(RES, '>tmp2') or die $!;

- print RES $t_result or die $!;

- print `diff tmp1 tmp2`;

- close RES;

- close OUT;

- print "\n";

- `rm tmp?`;

-# End of added part

- $tests_failed++;

- }

-}

-

-print "\n\n";

-print "$tests_passed passed; $tests_failed failed.\n";

-

-my $time_end = new Benchmark;

-my $time_diff = timediff($time_end, $time_start);

-print "Benchmark: ", timestr($time_diff), "\n";

-

-

-__END__

-

-=pod

-

-=head1 NAME

-

-B<MarkdownTest>

-

-

-=head1 SYNOPSIS

-

-B<MarkdownTest.pl> [ B<--options> ] [ I<file> ... ]

-

-

-=head1 DESCRIPTION

-

-

-=head1 OPTIONS

-

-Use "--" to end switch parsing. For example, to open a file named "-z", use:

-

- MarkdownTest.pl -- -z

-

-=over 4

-

-=item B<--script>

-

-Specify the path to the Markdown script to test. Defaults to

-"./Markdown.pl". Example:

-

- ./MarkdownTest.pl --script ./PHP-Markdown/php-markdown

-

-=item B<--testdir>

-

-Specify the path to a directory containing test data. Defaults to "Tests".

-

-=item B<--tidy>

-

-Flag to turn on using the command line 'tidy' tool to normalize HTML

-output before comparing script output to the expected test result.

-Assumes that the 'tidy' command is available in your PATH. Defaults to

-off.

-

-=back

-

-

-

-=head1 BUGS

-

-

-

-=head1 VERSION HISTORY

-

-1.0 Mon 13 Dec 2004-2005

-

-1.0.1 Mon 19 Sep 2005

-

- + Better handling of case when foo.text exists, but foo.html doesn't.

- It now prints a message and moves on, rather than dying.

-

-

-=head1 COPYRIGHT AND LICENSE

-

-Copyright (c) 2004-2005 John Gruber

-<http://daringfireball.net/>

-All rights reserved.

-

-This is free software; you may redistribute it and/or modify it under

-the same terms as Perl itself.

-

-=cut

-<p>AT&amp;T has an ampersand in their name.</p>

-

-<p>AT&amp;T is another way to write it.</p>

-

-<p>This &amp; that.</p>

-

-<p>4 &lt; 5.</p>

-

-<p>6 > 5.</p>

-

-<p>Here's a <a href="http://example.com/?foo=1&amp;bar=2">link</a> with an ampersand in the URL.</p>

-

-<p>Here's a link with an amersand in the link text: <a href="http://att.com/" title="AT&amp;T">AT&amp;T</a>.</p>

-

-<p>Here's an inline <a href="/script?foo=1&amp;bar=2">link</a>.</p>

-

-<p>Here's an inline <a href="/script?foo=1&amp;bar=2">link</a>.</p>

-AT&T has an ampersand in their name.

-

-AT&amp;T is another way to write it.

-

-This & that.

-

-4 < 5.

-

-6 > 5.

-

-Here's a [link] [1] with an ampersand in the URL.

-

-Here's a link with an amersand in the link text: [AT&T] [2].

-

-Here's an inline [link](/script?foo=1&bar=2).

-

-Here's an inline [link](</script?foo=1&bar=2>).

-

-

-[1]: http://example.com/?foo=1&bar=2

-[2]: http://att.com/ "AT&T" \ No newline at end of file

-<p>Link: <a href="http://example.com/">http://example.com/</a>.</p>

-

-<p>With an ampersand: <a href="http://example.com/?foo=1&amp;bar=2">http://example.com/?foo=1&amp;bar=2</a></p>

-

-<ul>

-<li>In a list?</li>

-<li><a href="http://example.com/">http://example.com/</a></li>

-<li>It should.</li>

-</ul>

-

-<blockquote>

- <p>Blockquoted: <a href="http://example.com/">http://example.com/</a></p>

-</blockquote>

-

-<p>Auto-links should not occur here: <code>&lt;http://example.com/&gt;</code></p>

-

-<pre><code>or here: &lt;http://example.com/&gt;

-</code></pre>

-Link: <http://example.com/>.

-

-With an ampersand: <http://example.com/?foo=1&bar=2>

-

-* In a list?

-* <http://example.com/>

-* It should.

-

-> Blockquoted: <http://example.com/>

-

-Auto-links should not occur here: `<http://example.com/>`

-

- or here: <http://example.com/> \ No newline at end of file

-<p>These should all get escaped:</p>

-

-<p>Backslash: \</p>

-

-<p>Backtick: `</p>

-

-<p>Asterisk: *</p>

-

-<p>Underscore: _</p>

-

-<p>Left brace: {</p>

-

-<p>Right brace: }</p>

-

-<p>Left bracket: [</p>

-

-<p>Right bracket: ]</p>

-

-<p>Left paren: (</p>

-

-<p>Right paren: )</p>

-

-<p>Greater-than: ></p>

-

-<p>Hash: #</p>

-

-<p>Period: .</p>

-

-<p>Bang: !</p>

-

-<p>Plus: +</p>

-

-<p>Minus: -</p>

-

-<p>These should not, because they occur within a code block:</p>

-

-<pre><code>Backslash: \\

-

-Backtick: \`

-

-Asterisk: \*

-

-Underscore: \_

-

-Left brace: \{

-

-Right brace: \}

-

-Left bracket: \[

-

-Right bracket: \]

-

-Left paren: \(

-

-Right paren: \)

-

-Greater-than: \&gt;

-

-Hash: \#

-

-Period: \.

-

-Bang: \!

-

-Plus: \+

-

-Minus: \-

-</code></pre>

-

-<p>Nor should these, which occur in code spans:</p>

-

-<p>Backslash: <code>\\</code></p>

-

-<p>Backtick: <code>\`</code></p>

-

-<p>Asterisk: <code>\*</code></p>

-

-<p>Underscore: <code>\_</code></p>

-

-<p>Left brace: <code>\{</code></p>

-

-<p>Right brace: <code>\}</code></p>

-

-<p>Left bracket: <code>\[</code></p>

-

-<p>Right bracket: <code>\]</code></p>

-

-<p>Left paren: <code>\(</code></p>

-

-<p>Right paren: <code>\)</code></p>

-

-<p>Greater-than: <code>\&gt;</code></p>

-

-<p>Hash: <code>\#</code></p>

-

-<p>Period: <code>\.</code></p>

-

-<p>Bang: <code>\!</code></p>

-

-<p>Plus: <code>\+</code></p>

-

-<p>Minus: <code>\-</code></p>

-

-

-<p>These should get escaped, even though they're matching pairs for

-other Markdown constructs:</p>

-

-<p>*asterisks*</p>

-

-<p>_underscores_</p>

-

-<p>`backticks`</p>

-

-<p>This is a code span with a literal backslash-backtick sequence: <code>\`</code></p>

-

-<p>This is a tag with unescaped backticks <span attr='`ticks`'>bar</span>.</p>

-

-<p>This is a tag with backslashes <span attr='\\backslashes\\'>bar</span>.</p>

-These should all get escaped:

-

-Backslash: \\

-

-Backtick: \`

-

-Asterisk: \*

-

-Underscore: \_

-

-Left brace: \{

-

-Right brace: \}

-

-Left bracket: \[

-

-Right bracket: \]

-

-Left paren: \(

-

-Right paren: \)

-

-Greater-than: \>

-

-Hash: \#

-

-Period: \.

-

-Bang: \!

-

-Plus: \+

-

-Minus: \-

-

-

-

-These should not, because they occur within a code block:

-

- Backslash: \\

-

- Backtick: \`

-

- Asterisk: \*

-

- Underscore: \_

-

- Left brace: \{

-

- Right brace: \}

-

- Left bracket: \[

-

- Right bracket: \]

-

- Left paren: \(

-

- Right paren: \)

-

- Greater-than: \>

-

- Hash: \#

-

- Period: \.

-

- Bang: \!

-

- Plus: \+

-

- Minus: \-

-

-

-Nor should these, which occur in code spans:

-

-Backslash: `\\`

-

-Backtick: `` \` ``

-

-Asterisk: `\*`

-

-Underscore: `\_`

-

-Left brace: `\{`

-

-Right brace: `\}`

-

-Left bracket: `\[`

-

-Right bracket: `\]`

-

-Left paren: `\(`

-

-Right paren: `\)`

-

-Greater-than: `\>`

-

-Hash: `\#`

-

-Period: `\.`

-

-Bang: `\!`

-

-Plus: `\+`

-

-Minus: `\-`

-

-

-These should get escaped, even though they're matching pairs for

-other Markdown constructs:

-

-\*asterisks\*

-

-\_underscores\_

-

-\`backticks\`

-

-This is a code span with a literal backslash-backtick sequence: `` \` ``

-

-This is a tag with unescaped backticks <span attr='`ticks`'>bar</span>.

-

-This is a tag with backslashes <span attr='\\backslashes\\'>bar</span>.

-<blockquote>

- <p>Example:</p>

-

-<pre><code>sub status {

- print "working";

-}

-</code></pre>

-

- <p>Or:</p>

-

-<pre><code>sub status {

- return "working";

-}

-</code></pre>

-</blockquote>

-> Example:

->

-> sub status {

-> print "working";

-> }

->

-> Or:

->

-> sub status {

-> return "working";

-> }

-<pre><code>code block on the first line

-</code></pre>

-

-<p>Regular text.</p>

-

-<pre><code>code block indented by spaces

-</code></pre>

-

-<p>Regular text.</p>

-

-<pre><code>the lines in this block

-all contain trailing spaces

-</code></pre>

-

-<p>Regular Text.</p>

-

-<pre><code>code block on the last line

-</code></pre>

- code block on the first line

-

-Regular text.

-

- code block indented by spaces

-

-Regular text.

-

- the lines in this block

- all contain trailing spaces

-

-Regular Text.

-

- code block on the last line \ No newline at end of file

-<p><code>&lt;test a="</code> content of attribute <code>"&gt;</code></p>

-

-<p>Fix for backticks within HTML tag: <span attr='`ticks`'>like this</span></p>

-

-<p>Here's how you put <code>`backticks`</code> in a code span.</p>

-

-`<test a="` content of attribute `">`

-

-Fix for backticks within HTML tag: <span attr='`ticks`'>like this</span>

-

-Here's how you put `` `backticks` `` in a code span.

-

-<p>In Markdown 1.0.0 and earlier. Version

-8. This line turns into a list item.

-Because a hard-wrapped line in the

-middle of a paragraph looked like a

-list item.</p>

-

-<p>Here's one with a bullet.

-* criminey.</p>

-In Markdown 1.0.0 and earlier. Version

-8. This line turns into a list item.

-Because a hard-wrapped line in the

-middle of a paragraph looked like a

-list item.

-

-Here's one with a bullet.

-* criminey.

-<p>Dashes:</p>

-

-<hr />

-

-<hr />

-

-<hr />

-

-<hr />

-

-<pre><code>---

-</code></pre>

-

-<hr />

-

-<hr />

-

-<hr />

-

-<hr />

-

-<pre><code>- - -

-</code></pre>

-

-<p>Asterisks:</p>

-

-<hr />

-

-<hr />

-

-<hr />

-

-<hr />

-

-<pre><code>***

-</code></pre>

-

-<hr />

-

-<hr />

-

-<hr />

-

-<hr />

-

-<pre><code>* * *

-</code></pre>

-

-<p>Underscores:</p>

-

-<hr />

-

-<hr />

-

-<hr />

-

-<hr />

-

-<pre><code>___

-</code></pre>

-

-<hr />

-

-<hr />

-

-<hr />

-

-<hr />

-

-<pre><code>_ _ _

-</code></pre>

-Dashes:

-

----

-

- ---

-

- ---

-

- ---

-

- ---

-

-- - -

-

- - - -

-

- - - -

-

- - - -

-

- - - -

-

-

-Asterisks:

-

-***

-

- ***

-

- ***

-

- ***

-

- ***

-

-* * *

-

- * * *

-

- * * *

-

- * * *

-

- * * *

-

-

-Underscores:

-

-___

-

- ___

-

- ___

-

- ___

-

- ___

-

-_ _ _

-

- _ _ _

-

- _ _ _

-

- _ _ _

-

- _ _ _

-<p>Simple block on one line:</p>

-

-<div>foo</div>

-

-<p>And nested without indentation:</p>

-

-<div>

-<div>

-<div>

-foo

-</div>

-<div style=">"/>

-</div>

-<div>bar</div>

-</div>

-Simple block on one line:

-

-<div>foo</div>

-

-And nested without indentation:

-

-<div>

-<div>

-<div>

-foo

-</div>

-<div style=">"/>

-</div>

-<div>bar</div>

-</div>

-<p>Here's a simple block:</p>

-

-<div>

- foo

-</div>

-

-<p>This should be a code block, though:</p>

-

-<pre><code>&lt;div&gt;

- foo

-&lt;/div&gt;

-</code></pre>

-

-<p>As should this:</p>

-

-<pre><code>&lt;div&gt;foo&lt;/div&gt;

-</code></pre>

-

-<p>Now, nested:</p>

-

-<div>

- <div>

- <div>

- foo

- </div>

- </div>

-</div>

-

-<p>This should just be an HTML comment:</p>

-

-<!-- Comment -->

-

-<p>Multiline:</p>

-

-<!--

-Blah

-Blah

--->

-

-<p>Code block:</p>

-

-<pre><code>&lt;!-- Comment --&gt;

-</code></pre>

-

-<p>Just plain comment, with trailing spaces on the line:</p>

-

-<!-- foo -->

-

-<p>Code:</p>

-

-<pre><code>&lt;hr /&gt;

-</code></pre>

-

-<p>Hr's:</p>

-

-<hr>

-

-<hr/>

-

-<hr />

-

-<hr>

-

-<hr/>

-

-<hr />

-

-<hr class="foo" id="bar" />

-

-<hr class="foo" id="bar"/>

-

-<hr class="foo" id="bar" >

-Here's a simple block:

-

-<div>

- foo

-</div>

-

-This should be a code block, though:

-

- <div>

- foo

- </div>

-

-As should this:

-

- <div>foo</div>

-

-Now, nested:

-

-<div>

- <div>

- <div>

- foo

- </div>

- </div>

-</div>

-

-This should just be an HTML comment:

-

-<!-- Comment -->

-

-Multiline:

-

-<!--

-Blah

-Blah

--->

-

-Code block:

-

- <!-- Comment -->

-

-Just plain comment, with trailing spaces on the line:

-

-<!-- foo -->

-

-Code:

-

- <hr />

-

-Hr's:

-

-<hr>

-

-<hr/>

-

-<hr />

-

-<hr>

-

-<hr/>

-

-<hr />

-

-<hr class="foo" id="bar" />

-

-<hr class="foo" id="bar"/>

-

-<hr class="foo" id="bar" >

-

-<p>Paragraph one.</p>

-

-<!-- This is a simple comment -->

-

-<!--

- This is another comment.

--->

-

-<p>Paragraph two.</p>

-

-<!-- one comment block -- -- with two comments -->

-

-<p>The end.</p>

-Paragraph one.

-

-<!-- This is a simple comment -->

-

-<!--

- This is another comment.

--->

-

-Paragraph two.

-

-<!-- one comment block -- -- with two comments -->

-

-The end.

-<p>Just a <a href="/url/">URL</a>.</p>

-

-<p><a href="/url/" title="title">URL and title</a>.</p>

-

-<p><a href="/url/" title="title preceded by two spaces">URL and title</a>.</p>

-

-<p><a href="/url/" title="title preceded by a tab">URL and title</a>.</p>

-

-<p><a href="/url/" title="title has spaces afterward">URL and title</a>.</p>

-

-<p><a href="">Empty</a>.</p>

-Just a [URL](/url/).

-

-[URL and title](/url/ "title").

-

-[URL and title](/url/ "title preceded by two spaces").

-

-[URL and title](/url/ "title preceded by a tab").

-

-[URL and title](/url/ "title has spaces afterward" ).

-

-

-[Empty]().

-<p>Foo <a href="/url/" title="Title">bar</a>.</p>

-

-<p>Foo <a href="/url/" title="Title">bar</a>.</p>

-

-<p>Foo <a href="/url/" title="Title">bar</a>.</p>

-

-<p>With <a href="/url/">embedded [brackets]</a>.</p>

-

-<p>Indented <a href="/url">once</a>.</p>

-

-<p>Indented <a href="/url">twice</a>.</p>

-

-<p>Indented <a href="/url">thrice</a>.</p>

-

-<p>Indented [four][] times.</p>

-

-<pre><code>[four]: /url

-</code></pre>

-

-<hr />

-

-<p><a href="foo">this</a> should work</p>

-

-<p>So should <a href="foo">this</a>.</p>

-

-<p>And <a href="foo">this</a>.</p>

-

-<p>And <a href="foo">this</a>.</p>

-

-<p>And <a href="foo">this</a>.</p>

-

-<p>But not [that] [].</p>

-

-<p>Nor [that][].</p>

-

-<p>Nor [that].</p>

-

-<p>[Something in brackets like <a href="foo">this</a> should work]</p>

-

-<p>[Same with <a href="foo">this</a>.]</p>

-

-<p>In this case, <a href="/somethingelse/">this</a> points to something else.</p>

-

-<p>Backslashing should suppress [this] and [this].</p>

-

-<hr />

-

-<p>Here's one where the <a href="/url/">link

-breaks</a> across lines.</p>

-

-<p>Here's another where the <a href="/url/">link

-breaks</a> across lines, but with a line-ending space.</p>

-Foo [bar] [1].

-

-Foo [bar][1].

-

-Foo [bar]

-[1].

-

-[1]: /url/ "Title"

-

-

-With [embedded [brackets]] [b].

-

-

-Indented [once][].

-

-Indented [twice][].

-

-Indented [thrice][].

-

-Indented [four][] times.

-

- [once]: /url

-

- [twice]: /url

-

- [thrice]: /url

-

- [four]: /url

-

-

-[b]: /url/

-

-* * *

-

-[this] [this] should work

-

-So should [this][this].

-

-And [this] [].

-

-And [this][].

-

-And [this].

-

-But not [that] [].

-

-Nor [that][].

-

-Nor [that].

-

-[Something in brackets like [this][] should work]

-

-[Same with [this].]

-

-In this case, [this](/somethingelse/) points to something else.

-

-Backslashing should suppress \[this] and [this\].

-

-[this]: foo

-

-

-* * *

-

-Here's one where the [link

-breaks] across lines.

-

-Here's another where the [link

-breaks] across lines, but with a line-ending space.

-

-

-[link breaks]: /url/

-<p>This is the <a href="/simple">simple case</a>.</p>

-

-<p>This one has a <a href="/foo">line

-break</a>.</p>

-

-<p>This one has a <a href="/foo">line

-break</a> with a line-ending space.</p>

-

-<p><a href="/that">this</a> and the <a href="/other">other</a></p>

-This is the [simple case].

-

-[simple case]: /simple

-

-

-

-This one has a [line

-break].

-

-This one has a [line

-break] with a line-ending space.

-

-[line break]: /foo

-

-

-[this] [that] and the [other]

-

-[this]: /this

-[that]: /that

-[other]: /other

-<p>Foo <a href="/url/" title="Title with &quot;quotes&quot; inside">bar</a>.</p>

-

-<p>Foo <a href="/url/" title="Title with &quot;quotes&quot; inside">bar</a>.</p>

-Foo [bar][].

-

-Foo [bar](/url/ "Title with "quotes" inside").

-

-

- [bar]: /url/ "Title with "quotes" inside"

-

-<h1>Markdown: Basics</h1>

-

-<ul id="ProjectSubmenu">

- <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>

- <li><a class="selected" title="Markdown Basics">Basics</a></li>

- <li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li>

- <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>

- <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>

-</ul>

-

-<h2>Getting the Gist of Markdown's Formatting Syntax</h2>

-

-<p>This page offers a brief overview of what it's like to use Markdown.

-The <a href="/projects/markdown/syntax" title="Markdown Syntax">syntax page</a> provides complete, detailed documentation for

-every feature, but Markdown should be very easy to pick up simply by

-looking at a few examples of it in action. The examples on this page

-are written in a before/after style, showing example syntax and the

-HTML output produced by Markdown.</p>

-

-<p>It's also helpful to simply try Markdown out; the <a href="/projects/markdown/dingus" title="Markdown Dingus">Dingus</a> is a

-web application that allows you type your own Markdown-formatted text

-and translate it to XHTML.</p>

-

-<p><strong>Note:</strong> This document is itself written using Markdown; you

-can <a href="/projects/markdown/basics.text">see the source for it by adding '.text' to the URL</a>.</p>

-

-<h2>Paragraphs, Headers, Blockquotes</h2>

-

-<p>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 spaces or tabs is considered

-blank.) Normal paragraphs should not be intended with spaces or tabs.</p>

-

-<p>Markdown offers two styles of headers: <em>Setext</em> and <em>atx</em>.

-Setext-style headers for <code>&lt;h1&gt;</code> and <code>&lt;h2&gt;</code> are created by

-"underlining" with equal signs (<code>=</code>) and hyphens (<code>-</code>), respectively.

-To create an atx-style header, you put 1-6 hash marks (<code>#</code>) at the

-beginning of the line -- the number of hashes equals the resulting

-HTML header level.</p>

-

-<p>Blockquotes are indicated using email-style '<code>&gt;</code>' angle brackets.</p>

-

-<p>Markdown:</p>

-

-<pre><code>A First Level Header

-====================

-

-A Second Level Header

----------------------

-

-Now is the time for all good men to come to

-the aid of their country. This is just a

-regular paragraph.

-

-The quick brown fox jumped over the lazy

-dog's back.

-

-### Header 3

-

-&gt; This is a blockquote.

-&gt;

-&gt; This is the second paragraph in the blockquote.

-&gt;

-&gt; ## This is an H2 in a blockquote

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;h1&gt;A First Level Header&lt;/h1&gt;

-

-&lt;h2&gt;A Second Level Header&lt;/h2&gt;

-

-&lt;p&gt;Now is the time for all good men to come to

-the aid of their country. This is just a

-regular paragraph.&lt;/p&gt;

-

-&lt;p&gt;The quick brown fox jumped over the lazy

-dog's back.&lt;/p&gt;

-

-&lt;h3&gt;Header 3&lt;/h3&gt;

-

-&lt;blockquote&gt;

- &lt;p&gt;This is a blockquote.&lt;/p&gt;

-

- &lt;p&gt;This is the second paragraph in the blockquote.&lt;/p&gt;

-

- &lt;h2&gt;This is an H2 in a blockquote&lt;/h2&gt;

-&lt;/blockquote&gt;

-</code></pre>

-

-<h3>Phrase Emphasis</h3>

-

-<p>Markdown uses asterisks and underscores to indicate spans of emphasis.</p>

-

-<p>Markdown:</p>

-

-<pre><code>Some of these words *are emphasized*.

-Some of these words _are emphasized also_.

-

-Use two asterisks for **strong emphasis**.

-Or, if you prefer, __use two underscores instead__.

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;p&gt;Some of these words &lt;em&gt;are emphasized&lt;/em&gt;.

-Some of these words &lt;em&gt;are emphasized also&lt;/em&gt;.&lt;/p&gt;

-

-&lt;p&gt;Use two asterisks for &lt;strong&gt;strong emphasis&lt;/strong&gt;.

-Or, if you prefer, &lt;strong&gt;use two underscores instead&lt;/strong&gt;.&lt;/p&gt;

-</code></pre>

-

-<h2>Lists</h2>

-

-<p>Unordered (bulleted) lists use asterisks, pluses, and hyphens (<code>*</code>,

-<code>+</code>, and <code>-</code>) as list markers. These three markers are

-interchangable; this:</p>

-

-<pre><code>* Candy.

-* Gum.

-* Booze.

-</code></pre>

-

-<p>this:</p>

-

-<pre><code>+ Candy.

-+ Gum.

-+ Booze.

-</code></pre>

-

-<p>and this:</p>

-

-<pre><code>- Candy.

-- Gum.

-- Booze.

-</code></pre>

-

-<p>all produce the same output:</p>

-

-<pre><code>&lt;ul&gt;

-&lt;li&gt;Candy.&lt;/li&gt;

-&lt;li&gt;Gum.&lt;/li&gt;

-&lt;li&gt;Booze.&lt;/li&gt;

-&lt;/ul&gt;

-</code></pre>

-

-<p>Ordered (numbered) lists use regular numbers, followed by periods, as

-list markers:</p>

-

-<pre><code>1. Red

-2. Green

-3. Blue

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;ol&gt;

-&lt;li&gt;Red&lt;/li&gt;

-&lt;li&gt;Green&lt;/li&gt;

-&lt;li&gt;Blue&lt;/li&gt;

-&lt;/ol&gt;

-</code></pre>

-

-<p>If you put blank lines between items, you'll get <code>&lt;p&gt;</code> tags for the

-list item text. You can create multi-paragraph list items by indenting

-the paragraphs by 4 spaces or 1 tab:</p>

-

-<pre><code>* A list item.

-

- With multiple paragraphs.

-

-* Another item in the list.

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;ul&gt;

-&lt;li&gt;&lt;p&gt;A list item.&lt;/p&gt;

-&lt;p&gt;With multiple paragraphs.&lt;/p&gt;&lt;/li&gt;

-&lt;li&gt;&lt;p&gt;Another item in the list.&lt;/p&gt;&lt;/li&gt;

-&lt;/ul&gt;

-</code></pre>

-

-<h3>Links</h3>

-

-<p>Markdown supports two styles for creating links: <em>inline</em> and

-<em>reference</em>. With both styles, you use square brackets to delimit the

-text you want to turn into a link.</p>

-

-<p>Inline-style links use parentheses immediately after the link text.

-For example:</p>

-

-<pre><code>This is an [example link](http://example.com/).

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;p&gt;This is an &lt;a href="http://example.com/"&gt;

-example link&lt;/a&gt;.&lt;/p&gt;

-</code></pre>

-

-<p>Optionally, you may include a title attribute in the parentheses:</p>

-

-<pre><code>This is an [example link](http://example.com/ "With a Title").

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;p&gt;This is an &lt;a href="http://example.com/" title="With a Title"&gt;

-example link&lt;/a&gt;.&lt;/p&gt;

-</code></pre>

-

-<p>Reference-style links allow you to refer to your links by names, which

-you define elsewhere in your document:</p>

-

-<pre><code>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"

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;p&gt;I get 10 times more traffic from &lt;a href="http://google.com/"

-title="Google"&gt;Google&lt;/a&gt; than from &lt;a href="http://search.yahoo.com/"

-title="Yahoo Search"&gt;Yahoo&lt;/a&gt; or &lt;a href="http://search.msn.com/"

-title="MSN Search"&gt;MSN&lt;/a&gt;.&lt;/p&gt;

-</code></pre>

-

-<p>The title attribute is optional. Link names may contain letters,

-numbers and spaces, but are <em>not</em> case sensitive:</p>

-

-<pre><code>I start my morning with a cup of coffee and

-[The New York Times][NY Times].

-

-[ny times]: http://www.nytimes.com/

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;p&gt;I start my morning with a cup of coffee and

-&lt;a href="http://www.nytimes.com/"&gt;The New York Times&lt;/a&gt;.&lt;/p&gt;

-</code></pre>

-

-<h3>Images</h3>

-

-<p>Image syntax is very much like link syntax.</p>

-

-<p>Inline (titles are optional):</p>

-

-<pre><code>

-</code></pre>

-

-<p>Reference-style:</p>

-

-<pre><code>![alt text][id]

-

-[id]: /path/to/img.jpg "Title"

-</code></pre>

-

-<p>Both of the above examples produce the same output:</p>

-

-<pre><code>&lt;img src="/path/to/img.jpg" alt="alt text" title="Title" /&gt;

-</code></pre>

-

-<h3>Code</h3>

-

-<p>In a regular paragraph, you can create code span by wrapping text in

-backtick quotes. Any ampersands (<code>&amp;</code>) and angle brackets (<code>&lt;</code> or

-<code>&gt;</code>) will automatically be translated into HTML entities. This makes

-it easy to use Markdown to write about HTML example code:</p>

-

-<pre><code>I strongly recommend against using any `&lt;blink&gt;` tags.

-

-I wish SmartyPants used named entities like `&amp;mdash;`

-instead of decimal-encoded entites like `&amp;#8212;`.

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;p&gt;I strongly recommend against using any

-&lt;code&gt;&amp;lt;blink&amp;gt;&lt;/code&gt; tags.&lt;/p&gt;

-

-&lt;p&gt;I wish SmartyPants used named entities like

-&lt;code&gt;&amp;amp;mdash;&lt;/code&gt; instead of decimal-encoded

-entites like &lt;code&gt;&amp;amp;#8212;&lt;/code&gt;.&lt;/p&gt;

-</code></pre>

-

-<p>To specify an entire block of pre-formatted code, indent every line of

-the block by 4 spaces or 1 tab. Just like with code spans, <code>&amp;</code>, <code>&lt;</code>,

-and <code>&gt;</code> characters will be escaped automatically.</p>

-

-<p>Markdown:</p>

-

-<pre><code>If you want your page to validate under XHTML 1.0 Strict,

-you've got to put paragraph tags in your blockquotes:

-

- &lt;blockquote&gt;

- &lt;p&gt;For example.&lt;/p&gt;

- &lt;/blockquote&gt;

-</code></pre>

-

-<p>Output:</p>

-

-<pre><code>&lt;p&gt;If you want your page to validate under XHTML 1.0 Strict,

-you've got to put paragraph tags in your blockquotes:&lt;/p&gt;

-

-&lt;pre&gt;&lt;code&gt;&amp;lt;blockquote&amp;gt;

- &amp;lt;p&amp;gt;For example.&amp;lt;/p&amp;gt;

-&amp;lt;/blockquote&amp;gt;

-&lt;/code&gt;&lt;/pre&gt;

-</code></pre>

-Markdown: Basics

-================

-

-<ul id="ProjectSubmenu">

- <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>

- <li><a class="selected" title="Markdown Basics">Basics</a></li>

- <li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li>

- <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>

- <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>

-</ul>

-

-

-Getting the Gist of Markdown's Formatting Syntax

-------------------------------------------------

-

-This page offers a brief overview of what it's like to use Markdown.

-The [syntax page] [s] provides complete, detailed documentation for

-every feature, but Markdown should be very easy to pick up simply by

-looking at a few examples of it in action. The examples on this page

-are written in a before/after style, showing example syntax and the

-HTML output produced by Markdown.

-

-It's also helpful to simply try Markdown out; the [Dingus] [d] is a

-web application that allows you type your own Markdown-formatted text

-and translate it to XHTML.

-

-**Note:** This document is itself written using Markdown; you

-can [see the source for it by adding '.text' to the URL] [src].

-

- [s]: /projects/markdown/syntax "Markdown Syntax"

- [d]: /projects/markdown/dingus "Markdown Dingus"

- [src]: /projects/markdown/basics.text

-

-

-## Paragraphs, Headers, Blockquotes ##

-

-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 spaces or tabs is considered

-blank.) Normal paragraphs should not be intended with spaces or tabs.

-

-Markdown offers two styles of headers: *Setext* and *atx*.

-Setext-style headers for `<h1>` and `<h2>` are created by

-"underlining" with equal signs (`=`) and hyphens (`-`), respectively.

-To create an atx-style header, you put 1-6 hash marks (`#`) at the

-beginning of the line -- the number of hashes equals the resulting

-HTML header level.

-

-Blockquotes are indicated using email-style '`>`' angle brackets.

-

-Markdown:

-

- A First Level Header

- ====================

-

- A Second Level Header

- ---------------------

-

- Now is the time for all good men to come to

- the aid of their country. This is just a

- regular paragraph.

-

- The quick brown fox jumped over the lazy

- dog's back.

-

- ### Header 3

-

- > This is a blockquote.

- >

- > This is the second paragraph in the blockquote.

- >

- > ## This is an H2 in a blockquote

-

-

-Output:

-

- <h1>A First Level Header</h1>

-

- <h2>A Second Level Header</h2>

-

- <p>Now is the time for all good men to come to

- the aid of their country. This is just a

- regular paragraph.</p>

-

- <p>The quick brown fox jumped over the lazy

- dog's back.</p>

-

- <h3>Header 3</h3>

-

- <blockquote>

- <p>This is a blockquote.</p>

-

- <p>This is the second paragraph in the blockquote.</p>

-

- <h2>This is an H2 in a blockquote</h2>

- </blockquote>

-

-

-

-### Phrase Emphasis ###

-

-Markdown uses asterisks and underscores to indicate spans of emphasis.

-

-Markdown:

-

- Some of these words *are emphasized*.

- Some of these words _are emphasized also_.

-

- Use two asterisks for **strong emphasis**.

- Or, if you prefer, __use two underscores instead__.

-

-Output:

-

- <p>Some of these words <em>are emphasized</em>.

- Some of these words <em>are emphasized also</em>.</p>

-

- <p>Use two asterisks for <strong>strong emphasis</strong>.

- Or, if you prefer, <strong>use two underscores instead</strong>.</p>

-

-

-

-## Lists ##

-

-Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,

-`+`, and `-`) as list markers. These three markers are

-interchangable; this:

-

- * Candy.

- * Gum.

- * Booze.

-

-this:

-

- + Candy.

- + Gum.

- + Booze.

-

-and this:

-

- - Candy.

- - Gum.

- - Booze.

-

-all produce the same output:

-

- <ul>

- <li>Candy.</li>

- <li>Gum.</li>

- <li>Booze.</li>

- </ul>

-

-Ordered (numbered) lists use regular numbers, followed by periods, as

-list markers:

-

- 1. Red

- 2. Green

- 3. Blue

-

-Output:

-

- <ol>

- <li>Red</li>

- <li>Green</li>

- <li>Blue</li>

- </ol>

-

-If you put blank lines between items, you'll get `<p>` tags for the

-list item text. You can create multi-paragraph list items by indenting

-the paragraphs by 4 spaces or 1 tab:

-

- * A list item.

-

- With multiple paragraphs.

-

- * Another item in the list.

-

-Output:

-

- <ul>

- <li><p>A list item.</p>

- <p>With multiple paragraphs.</p></li>

- <li><p>Another item in the list.</p></li>

- </ul>

-

-

-

-### Links ###

-

-Markdown supports two styles for creating links: *inline* and

-*reference*. With both styles, you use square brackets to delimit the

-text you want to turn into a link.

-

-Inline-style links use parentheses immediately after the link text.

-For example:

-

- This is an [example link](http://example.com/).

-

-Output:

-

- <p>This is an <a href="http://example.com/">

- example link</a>.</p>

-

-Optionally, you may include a title attribute in the parentheses:

-

- This is an [example link](http://example.com/ "With a Title").

-

-Output:

-

- <p>This is an <a href="http://example.com/" title="With a Title">

- example link</a>.</p>

-

-Reference-style links allow you to refer to your links by names, which

-you define elsewhere in your document:

-

- 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"

-

-Output:

-

- <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>

-

-The title attribute is optional. Link names may contain letters,

-numbers and spaces, but are *not* case sensitive:

-

- I start my morning with a cup of coffee and

- [The New York Times][NY Times].

-

- [ny times]: http://www.nytimes.com/

-

-Output:

-

- <p>I start my morning with a cup of coffee and

- <a href="http://www.nytimes.com/">The New York Times</a>.</p>

-

-

-### Images ###

-

-Image syntax is very much like link syntax.

-

-Inline (titles are optional):

-

- 

-

-Reference-style:

-

- ![alt text][id]

-

- [id]: /path/to/img.jpg "Title"

-

-Both of the above examples produce the same output:

-

- <img src="/path/to/img.jpg" alt="alt text" title="Title" />

-

-

-

-### Code ###

-

-In a regular paragraph, you can create code span by wrapping text in

-backtick quotes. Any ampersands (`&`) and angle brackets (`<` or

-`>`) will automatically be translated into HTML entities. This makes

-it easy to use Markdown to write about HTML example code:

-

- I strongly recommend against using any `<blink>` tags.

-

- I wish SmartyPants used named entities like `&mdash;`

- instead of decimal-encoded entites like `&#8212;`.

-

-Output:

-

- <p>I strongly recommend against using any

- <code>&lt;blink&gt;</code> tags.</p>

-

- <p>I wish SmartyPants used named entities like

- <code>&amp;mdash;</code> instead of decimal-encoded

- entites like <code>&amp;#8212;</code>.</p>

-

-

-To specify an entire block of pre-formatted code, indent every line of

-the block by 4 spaces or 1 tab. Just like with code spans, `&`, `<`,

-and `>` characters will be escaped automatically.

-

-Markdown:

-

- If you want your page to validate under XHTML 1.0 Strict,

- you've got to put paragraph tags in your blockquotes:

-

- <blockquote>

- <p>For example.</p>

- </blockquote>

-

-Output:

-

- <p>If you want your page to validate under XHTML 1.0 Strict,

- you've got to put paragraph tags in your blockquotes:</p>

-

- <pre><code>&lt;blockquote&gt;

- &lt;p&gt;For example.&lt;/p&gt;

- &lt;/blockquote&gt;

- </code></pre>

-<h1>Markdown: Syntax</h1>

-

-<ul id="ProjectSubmenu">

- <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>

- <li><a href="/projects/markdown/basics" title="Markdown Basics">Basics</a></li>

- <li><a class="selected" title="Markdown Syntax Documentation">Syntax</a></li>

- <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>

- <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>

-</ul>

-

-<ul>

-<li><a href="#overview">Overview</a>

-<ul>

-<li><a href="#philosophy">Philosophy</a></li>

-<li><a href="#html">Inline HTML</a></li>

-<li><a href="#autoescape">Automatic Escaping for Special Characters</a></li>

-</ul></li>

-<li><a href="#block">Block Elements</a>

-<ul>

-<li><a href="#p">Paragraphs and Line Breaks</a></li>

-<li><a href="#header">Headers</a></li>

-<li><a href="#blockquote">Blockquotes</a></li>

-<li><a href="#list">Lists</a></li>

-<li><a href="#precode">Code Blocks</a></li>

-<li><a href="#hr">Horizontal Rules</a></li>

-</ul></li>

-<li><a href="#span">Span Elements</a>

-<ul>

-<li><a href="#link">Links</a></li>

-<li><a href="#em">Emphasis</a></li>

-<li><a href="#code">Code</a></li>

-<li><a href="#img">Images</a></li>

-</ul></li>

-<li><a href="#misc">Miscellaneous</a>

-<ul>

-<li><a href="#backslash">Backslash Escapes</a></li>

-<li><a href="#autolink">Automatic Links</a></li>

-</ul></li>

-</ul>

-

-<p><strong>Note:</strong> This document is itself written using Markdown; you

-can <a href="/projects/markdown/syntax.text">see the source for it by adding '.text' to the URL</a>.</p>

-

-<hr />

-

-<h2 id="overview">Overview</h2>

-

-<h3 id="philosophy">Philosophy</h3>

-

-<p>Markdown is intended to be as easy-to-read and easy-to-write as is feasible.</p>

-

-<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 <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a>, <a href="http://www.aaronsw.com/2002/atx/">atx</a>, <a href="http://textism.com/tools/textile/">Textile</a>, <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>,

-<a href="http://www.triptico.com/software/grutatxt.html">Grutatext</a>, and <a href="http://ettext.taint.org/doc/">EtText</a> -- the single biggest source of

-inspiration for Markdown's syntax is the format of plain text email.</p>

-

-<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.</p>

-

-<h3 id="html">Inline HTML</h3>

-

-<p>Markdown's syntax is intended for one purpose: to be used as a

-format for <em>writing</em> for the web.</p>

-

-<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 <em>not</em> 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 <em>publishing</em> format; Markdown is a <em>writing</em>

-format. Thus, Markdown's formatting syntax only addresses issues that

-can be conveyed in plain text.</p>

-

-<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>

-

-<p>The only restrictions are that block-level HTML elements -- e.g. <code>&lt;div&gt;</code>,

-<code>&lt;table&gt;</code>, <code>&lt;pre&gt;</code>, <code>&lt;p&gt;</code>, 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) <code>&lt;p&gt;</code> tags around HTML block-level tags.</p>

-

-<p>For example, to add an HTML table to a Markdown article:</p>

-

-<pre><code>This is a regular paragraph.

-

-&lt;table&gt;

- &lt;tr&gt;

- &lt;td&gt;Foo&lt;/td&gt;

- &lt;/tr&gt;

-&lt;/table&gt;

-

-This is another regular paragraph.

-</code></pre>

-

-<p>Note that Markdown formatting syntax is not processed within block-level

-HTML tags. E.g., you can't use Markdown-style <code>*emphasis*</code> inside an

-HTML block.</p>

-

-<p>Span-level HTML tags -- e.g. <code>&lt;span&gt;</code>, <code>&lt;cite&gt;</code>, or <code>&lt;del&gt;</code> -- 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 <code>&lt;a&gt;</code> or <code>&lt;img&gt;</code> tags instead of Markdown's

-link or image syntax, go right ahead.</p>

-

-<p>Unlike block-level HTML tags, Markdown syntax <em>is</em> processed within

-span-level tags.</p>

-

-<h3 id="autoescape">Automatic Escaping for Special Characters</h3>

-

-<p>In HTML, there are two characters that demand special treatment: <code>&lt;</code>

-and <code>&amp;</code>. 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. <code>&amp;lt;</code>, and

-<code>&amp;amp;</code>.</p>

-

-<p>Ampersands in particular are bedeviling for web writers. If you want to

-write about 'AT&amp;T', you need to write '<code>AT&amp;amp;T</code>'. You even need to

-escape ampersands within URLs. Thus, if you want to link to:</p>

-

-<pre><code>http://images.google.com/images?num=30&amp;q=larry+bird

-</code></pre>

-

-<p>you need to encode the URL as:</p>

-

-<pre><code>http://images.google.com/images?num=30&amp;amp;q=larry+bird

-</code></pre>

-

-<p>in your anchor tag <code>href</code> 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>

-

-<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 <code>&amp;amp;</code>.</p>

-

-<p>So, if you want to include a copyright symbol in your article, you can write:</p>

-

-<pre><code>&amp;copy;

-</code></pre>

-

-<p>and Markdown will leave it alone. But if you write:</p>

-

-<pre><code>AT&amp;T

-</code></pre>

-

-<p>Markdown will translate it to:</p>

-

-<pre><code>AT&amp;amp;T

-</code></pre>

-

-<p>Similarly, because Markdown supports <a href="#html">inline HTML</a>, if you use

-angle brackets as delimiters for HTML tags, Markdown will treat them as

-such. But if you write:</p>

-

-<pre><code>4 &lt; 5

-</code></pre>

-

-<p>Markdown will translate it to:</p>

-

-<pre><code>4 &amp;lt; 5

-</code></pre>

-

-<p>However, inside Markdown code spans and blocks, angle brackets and

-ampersands are <em>always</em> 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 <code>&lt;</code>

-and <code>&amp;</code> in your example code needs to be escaped.)</p>

-

-<hr />

-

-<h2 id="block">Block Elements</h2>

-

-<h3 id="p">Paragraphs and Line Breaks</h3>

-

-<p>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 intended with spaces or tabs.</p>

-

-<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 <code>&lt;br /&gt;</code> tag.</p>

-

-<p>When you <em>do</em> want to insert a <code>&lt;br /&gt;</code> break tag using Markdown, you

-end a line with two or more spaces, then type return.</p>

-

-<p>Yes, this takes a tad more effort to create a <code>&lt;br /&gt;</code>, but a simplistic

-"every line break is a <code>&lt;br /&gt;</code>" rule wouldn't work for Markdown.

-Markdown's email-style <a href="#blockquote">blockquoting</a> and multi-paragraph <a href="#list">list items</a>

-work best -- and look better -- when you format them with hard breaks.</p>

-

-<h3 id="header">Headers</h3>

-

-<p>Markdown supports two styles of headers, <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a> and <a href="http://www.aaronsw.com/2002/atx/">atx</a>.</p>

-

-<p>Setext-style headers are "underlined" using equal signs (for first-level

-headers) and dashes (for second-level headers). For example:</p>

-

-<pre><code>This is an H1

-=============

-

-This is an H2

--------------

-</code></pre>

-

-<p>Any number of underlining <code>=</code>'s or <code>-</code>'s will work.</p>

-

-<p>Atx-style headers use 1-6 hash characters at the start of the line,

-corresponding to header levels 1-6. For example:</p>

-

-<pre><code># This is an H1

-

-## This is an H2

-

-###### This is an H6

-</code></pre>

-

-<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.) :</p>

-

-<pre><code># This is an H1 #

-

-## This is an H2 ##

-

-### This is an H3 ######

-</code></pre>

-

-<h3 id="blockquote">Blockquotes</h3>

-

-<p>Markdown uses email-style <code>&gt;</code> 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 <code>&gt;</code> before every line:</p>

-

-<pre><code>&gt; This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,

-&gt; consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

-&gt; Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

-&gt;

-&gt; Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse

-&gt; id sem consectetuer libero luctus adipiscing.

-</code></pre>

-

-<p>Markdown allows you to be lazy and only put the <code>&gt;</code> before the first

-line of a hard-wrapped paragraph:</p>

-

-<pre><code>&gt; 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.

-

-&gt; Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse

-id sem consectetuer libero luctus adipiscing.

-</code></pre>

-

-<p>Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by

-adding additional levels of <code>&gt;</code>:</p>

-

-<pre><code>&gt; This is the first level of quoting.

-&gt;

-&gt; &gt; This is nested blockquote.

-&gt;

-&gt; Back to the first level.

-</code></pre>

-

-<p>Blockquotes can contain other Markdown elements, including headers, lists,

-and code blocks:</p>

-

-<pre><code>&gt; ## This is a header.

-&gt;

-&gt; 1. This is the first list item.

-&gt; 2. This is the second list item.

-&gt;

-&gt; Here's some example code:

-&gt;

-&gt; return shell_exec("echo $input | $markdown_script");

-</code></pre>

-

-<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.</p>

-

-<h3 id="list">Lists</h3>

-

-<p>Markdown supports ordered (numbered) and unordered (bulleted) lists.</p>

-

-<p>Unordered lists use asterisks, pluses, and hyphens -- interchangably

--- as list markers:</p>

-

-<pre><code>* Red

-* Green

-* Blue

-</code></pre>

-

-<p>is equivalent to:</p>

-

-<pre><code>+ Red

-+ Green

-+ Blue

-</code></pre>

-

-<p>and:</p>

-

-<pre><code>- Red

-- Green

-- Blue

-</code></pre>

-

-<p>Ordered lists use numbers followed by periods:</p>

-

-<pre><code>1. Bird

-2. McHale

-3. Parish

-</code></pre>

-

-<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:</p>

-

-<pre><code>&lt;ol&gt;

-&lt;li&gt;Bird&lt;/li&gt;

-&lt;li&gt;McHale&lt;/li&gt;

-&lt;li&gt;Parish&lt;/li&gt;

-&lt;/ol&gt;

-</code></pre>

-

-<p>If you instead wrote the list in Markdown like this:</p>

-

-<pre><code>1. Bird

-1. McHale

-1. Parish

-</code></pre>

-

-<p>or even:</p>

-

-<pre><code>3. Bird

-1. McHale

-8. Parish

-</code></pre>

-

-<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>

-

-<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>

-

-<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>

-

-<p>To make lists look nice, you can wrap items with hanging indents:</p>

-

-<pre><code>* 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.

-</code></pre>

-

-<p>But if you want to be lazy, you don't have to:</p>

-

-<pre><code>* 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.

-</code></pre>

-

-<p>If list items are separated by blank lines, Markdown will wrap the

-items in <code>&lt;p&gt;</code> tags in the HTML output. For example, this input:</p>

-

-<pre><code>* Bird

-* Magic

-</code></pre>

-

-<p>will turn into:</p>

-

-<pre><code>&lt;ul&gt;

-&lt;li&gt;Bird&lt;/li&gt;

-&lt;li&gt;Magic&lt;/li&gt;

-&lt;/ul&gt;

-</code></pre>

-

-<p>But this:</p>

-

-<pre><code>* Bird

-

-* Magic

-</code></pre>

-

-<p>will turn into:</p>

-

-<pre><code>&lt;ul&gt;

-&lt;li&gt;&lt;p&gt;Bird&lt;/p&gt;&lt;/li&gt;

-&lt;li&gt;&lt;p&gt;Magic&lt;/p&gt;&lt;/li&gt;

-&lt;/ul&gt;

-</code></pre>

-

-<p>List items may consist of multiple paragraphs. Each subsequent

-paragraph in a list item must be intended by either 4 spaces

-or one tab:</p>

-

-<pre><code>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.

-</code></pre>

-

-<p>It looks nice if you indent every line of the subsequent

-paragraphs, but here again, Markdown will allow you to be

-lazy:</p>

-

-<pre><code>* 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.

-</code></pre>

-

-<p>To put a blockquote within a list item, the blockquote's <code>&gt;</code>

-delimiters need to be indented:</p>

-

-<pre><code>* A list item with a blockquote:

-

- &gt; This is a blockquote

- &gt; inside a list item.

-</code></pre>

-

-<p>To put a code block within a list item, the code block needs

-to be indented <em>twice</em> -- 8 spaces or two tabs:</p>

-

-<pre><code>* A list item with a code block:

-

- &lt;code goes here&gt;

-</code></pre>

-

-<p>It's worth noting that it's possible to trigger an ordered list by

-accident, by writing something like this:</p>

-

-<pre><code>1986. What a great season.

-</code></pre>

-

-<p>In other words, a <em>number-period-space</em> sequence at the beginning of a

-line. To avoid this, you can backslash-escape the period:</p>

-

-<pre><code>1986\. What a great season.

-</code></pre>

-

-<h3 id="precode">Code Blocks</h3>

-

-<p>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 <code>&lt;pre&gt;</code> and <code>&lt;code&gt;</code> tags.</p>

-

-<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:</p>

-

-<pre><code>This is a normal paragraph:

-

- This is a code block.

-</code></pre>

-

-<p>Markdown will generate:</p>

-

-<pre><code>&lt;p&gt;This is a normal paragraph:&lt;/p&gt;

-

-&lt;pre&gt;&lt;code&gt;This is a code block.

-&lt;/code&gt;&lt;/pre&gt;

-</code></pre>

-

-<p>One level of indentation -- 4 spaces or 1 tab -- is removed from each

-line of the code block. For example, this:</p>

-

-<pre><code>Here is an example of AppleScript:

-

- tell application "Foo"

- beep

- end tell

-</code></pre>

-

-<p>will turn into:</p>

-

-<pre><code>&lt;p&gt;Here is an example of AppleScript:&lt;/p&gt;

-

-&lt;pre&gt;&lt;code&gt;tell application "Foo"

- beep

-end tell

-&lt;/code&gt;&lt;/pre&gt;

-</code></pre>

-

-<p>A code block continues until it reaches a line that is not indented

-(or the end of the article).</p>

-

-<p>Within a code block, ampersands (<code>&amp;</code>) and angle brackets (<code>&lt;</code> and <code>&gt;</code>)

-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:</p>

-

-<pre><code> &lt;div class="footer"&gt;

- &amp;copy; 2004 Foo Corporation

- &lt;/div&gt;

-</code></pre>

-

-<p>will turn into:</p>

-

-<pre><code>&lt;pre&gt;&lt;code&gt;&amp;lt;div class="footer"&amp;gt;