main = putStrLn "Hello world!"Executive Summary
-- -- Default: @False@ -- -- Since 0.1.13 , msNoFollowExternal :: Bool } -- | See 'msFencedHandlers. -- -- Since 0.1.2 data FencedHandler = FHRaw (Text -> [Block Text]) -- ^ Wrap up the given raw content. | FHParsed ([Block Text] -> [Block Text]) -- ^ Wrap up the given parsed content. -- | @since 0.1.15 defaultMarkdownSettings :: MarkdownSettings defaultMarkdownSettings = MarkdownSettings { msXssProtect = True , msStandaloneHtml = empty , msFencedHandlers = codeFencedHandler "```" `mappend` codeFencedHandler "~~~" , msBlockCodeRenderer = \lang (_,rendered) -> case lang of Just l -> H.pre $ H.code H.! HA.class_ (H.toValue l) $ rendered Nothing -> H.pre $ H.code $ rendered , msLinkNewTab = False , msBlankBeforeBlockquote = True , msBlockFilter = id , msAddHeadingId = False , msNoFollowExternal = False } instance Default MarkdownSettings where def = defaultMarkdownSettings -- | Helper for creating a 'FHRaw'. -- -- Since 0.1.2 codeFencedHandler :: Text -- ^ Delimiter -> Map Text (Text -> FencedHandler) codeFencedHandler key = singleton key $ \lang -> FHRaw $ return . BlockCode (if T.null lang then Nothing else Just lang) -- | Helper for creating a 'FHParsed'. -- -- Note that the start and end parameters take a @Text@ parameter; this is the -- text following the delimiter. For example, with the markdown: -- -- > @@@ foo -- -- @foo@ would be passed to start and end. -- -- Since 0.1.2 htmlFencedHandler :: Text -- ^ Delimiter -> (Text -> Text) -- ^ start HTML -> (Text -> Text) -- ^ end HTML -> Map Text (Text -> FencedHandler) htmlFencedHandler key start end = singleton key $ \lang -> FHParsed $ \blocks -> BlockHtml (start lang) : blocks ++ [BlockHtml $ end lang] data ListType = Ordered | Unordered deriving (Show, Eq) data Block inline = BlockPara inline | BlockList ListType (Either inline [Block inline]) | BlockCode (Maybe Text) Text | BlockQuote [Block inline] | BlockHtml Text | BlockRule | BlockHeading Int inline | BlockReference Text Text | BlockPlainText inline deriving (Show, Eq) instance Functor Block where fmap f (BlockPara i) = BlockPara (f i) fmap f (BlockList lt (Left i)) = BlockList lt $ Left $ f i fmap f (BlockList lt (Right bs)) = BlockList lt $ Right $ map (fmap f) bs fmap _ (BlockCode a b) = BlockCode a b fmap f (BlockQuote bs) = BlockQuote $ map (fmap f) bs fmap _ (BlockHtml t) = BlockHtml t fmap _ BlockRule = BlockRule fmap f (BlockHeading level i) = BlockHeading level (f i) fmap _ (BlockReference x y) = BlockReference x y fmap f (BlockPlainText x) = BlockPlainText (f x) data Inline = InlineText Text | InlineItalic [Inline] | InlineBold [Inline] | InlineCode Text | InlineHtml Text | InlineLink Text (Maybe Text) [Inline] -- ^ URL, title, content | InlineImage Text (Maybe Text) Text -- ^ URL, title, content | InlineFootnoteRef Integer -- ^ The footnote reference in the body | InlineFootnote Integer deriving (Show, Eq) markdown-0.1.17.4/test/main.hs 0000644 0000000 0000000 00000027100 13350661306 014214 0 ustar 00 0000000 0000000 {-# LANGUAGE OverloadedStrings #-} import Text.Blaze.Html (toHtml) import Text.Blaze.Html5 (figure) import Test.Hspec import Text.Markdown import Data.Text.Lazy (Text, unpack, snoc, fromStrict) import qualified Data.ByteString as B import qualified Data.Text as T import Data.Text.Encoding (decodeUtf8) import qualified Data.Text.IO as TIO import qualified Data.Text.Lazy as TL import Text.Blaze.Html.Renderer.Text (renderHtml) import Control.Monad (forM_) import qualified Data.Set as Set import qualified Data.Map as Map import Data.List (isInfixOf, isSuffixOf) import Data.Maybe (fromMaybe) import Data.CallStack import System.Directory (getDirectoryContents) import System.FilePath ((), replaceExtension) import Block import Inline check :: HasCallStack => Text -> Text -> Expectation check html md = renderHtml (markdown def md) `shouldBe` html checkSet :: MarkdownSettings -> Text -> Text -> Expectation checkSet set html md = renderHtml (markdown set md) `shouldBe` html check' :: Text -> Text -> Expectation check' html md = renderHtml (markdown def { msXssProtect = False } md) `shouldBe` html checkNoNL :: Text -> Text -> Expectation checkNoNL html md = f (renderHtml $ markdown def { msXssProtect = False } md) `shouldBe` f html where f = TL.filter (/= '\n') -- FIXME add quickcheck: all input is valid main :: IO () main = do examples <- getExamples gruber <- getGruber hspec $ do describe "block" blockSpecs describe "inline" inlineSpecs describe "line break" $ do it "is inserted for a single newline after two spaces" $ check "Hello
World!
Hello
World!
Q1
Q2
P2
" "> Q1 \nQ2\n\nP2" it "consumes all trailing whitespace on the previous line" $ check "Hello
World!
Hello World!
" "Hello World!" it "multiline" $ check "Hello\nWorld!
" "Hello\nWorld!" it "multiple" $ check "Hello
World!
" "Hello\n\nWorld!" describe "italics" $ do it "simple" $ check "foo
" "*foo*" it "hanging" $ check "foo *
" "*foo* *" it "two" $ check "foo bar
" "*foo* *bar*" describe "italics under" $ do it "simple" $ check "foo
" "_foo_" it "hanging" $ check "foo _
" "_foo_ _" it "two" $ check "foo bar
" "_foo_ _bar_" describe "bold" $ do it "simple" $ check "foo
" "**foo**" it "hanging" $ check "foo **
" "**foo** **" it "two" $ check "foo bar
" "**foo** **bar**" describe "bold under" $ do it "simple" $ check "foo
" "__foo__" it "hanging" $ check "foo __
" "__foo__ __" it "two" $ check "foo bar
" "__foo__ __bar__" describe "html" $ do it "simple" $ check "paragraph
foo bar baz
foo\n bar\nbaz*foo_barbaz\\`bin
" "\\*foo\\_bar_baz_\\\\\\`bin" describe "bullets" $ do it "simple" $ check "- foo
- bar
- baz
- foo
- bar
- baz
foo
bar
baz
" "# foo\n\n## bar\n\n###baz" it "trailing hashes" $ check "foo
" "# foo ####" it "underline" $ check "foo
bar
" "foo\n=============\n\nbar\n----------------\n" describe "headings with ID" $ do let withHeadingId = def { msAddHeadingId = True } it "without spaces" $ checkSet withHeadingId "foo
bar
baz
" "# foo\n\n## bar\n\n###baz" it "with spaces" $ checkSet withHeadingId "Executive summary
" "# Executive summary" it "with special characters" $ checkSet withHeadingId "Executive summary .!@#$%^*()-_=:
" "# Executive summary .!@#$%^*()-_=:" describe "blockquotes" $ do it "simple" $ check "" "> foo\n>\n> bar" describe "links" $ do it "simple" $ check "" "[bar](foo)" it "title" $ check "" "[bar](foo \"baz\")" it "escaped href" $ check "" "[bar](foo\\) \"baz\")" it "escaped title" $ check "" "[bar](foo\\) \"baz\\\"\")" it "inside a paragraph" $ check "foo
bar
Hello bar World
" "Hello [bar](foo) World" it "not a link" $ check "Not a [ link
" "Not a [ link" it "new tab" $ checkSet def { msLinkNewTab = True } "" "[bar](foo)" {- describe "github links" $ do it "simple" $ check "" "[[bar|foo]]" it "no link text" $ check "" "[[foo]]" it "escaping" $ check "" "[[bar|foo/baz bin]]" it "inside a list" $ check "" "* [[foo]]" -} describe "images" $ do it "simple" $ check "![\"foo\"](\"http://link.to/image.jpg\")
Hello World
Not an ![ image
" "Not an ![ image" describe "rules" $ do let options = concatMap (\t -> [t, snoc t '\n']) [ "* * *" , "***" , "*****" , "- - -" , "---------------------------------------" , "----------------------------------" ] forM_ options $ \o -> it (unpack o) $ check "" o describe "html" $ do it "inline" $ check "
foo
bar
bar" it "inline xss" $ check "
foo
bar
bar" it "block" $ check "
1 < 2
" "1 < 2" it "standalone" $ checkSet def { msStandaloneHtml = Set.fromList ["foo\nbarfoo
bar
[1]hello
" "{1}hello" it "references" $ check "[1]hello
" "{^1}hello" describe "examples" $ sequence_ examples describe "John Gruber's test suite" $ sequence_ gruber it "comments without spaces #22" $ check "" "" describe "no follow" $ do it "external 1" $ checkSet (setNoFollowExternal def) "" "[example](http://example.com)" it "external 2" $ checkSet (setNoFollowExternal def) "" "[example](//example.com)" it "internal" $ checkSet (setNoFollowExternal def) "" "[example](/foo)" getExamples :: IO [Spec] getExamples = do files <- getDirectoryContents dir mapM go $ filter (".md" `isSuffixOf`) files where dir = "test/examples" go basename = do let fp = dir basename input <- decodeUtf8 <$> B.readFile fp output <- decodeUtf8 <$> B.readFile (replaceExtension fp "html") let (checker, stripper) | "-spec" `isInfixOf` fp = (check', dropFinalLF) | otherwise = (check, T.strip) return $ it basename $ checker (fromStrict $ stripper output) (fromStrict input) dropFinalLF t = fromMaybe t $ T.stripSuffix "\n" t getGruber :: IO [Spec] getGruber = do files <- getDirectoryContents dir mapM go $ filter (".text" `isSuffixOf`) files where dir = "test/Tests" go basename = do let fp = dir basename input <- decodeUtf8 <$> B.readFile fp output <- decodeUtf8 <$> B.readFile (replaceExtension fp "html") return $ it basename $ checkNoNL (fromStrict $ T.strip output) (fromStrict input) markdown-0.1.17.4/test/Block.hs 0000644 0000000 0000000 00000007033 13252373420 014323 0 ustar 00 0000000 0000000 {-# LANGUAGE OverloadedStrings #-} module Block ( blockSpecs ) where import Test.Hspec import Data.Text (Text) import Data.Conduit import qualified Data.Conduit.List as CL import Text.Markdown (def, MarkdownSettings(..)) import Text.Markdown.Block checkWith :: MarkdownSettings -> Text -> [Block Text] -> Expectation checkWith ms md blocks = runConduitPure (yield md .| toBlocks ms .| CL.consume) `shouldBe` blocks check :: Text -> [Block Text] -> Expectation check = checkWith def blockSpecs :: Spec blockSpecs = do describe "tilde code" $ do it "simple" $ check "~~~haskell\nfoo\n\nbar\n~~~" [BlockCode (Just "haskell") "foo\n\nbar"] it "no lang" $ check "~~~\nfoo\n\nbar\n~~~" [BlockCode Nothing "foo\n\nbar"] it "no close" $ check "~~~\nfoo\n\nbar\n" [BlockPara " ~~~\nfoo", BlockPara "bar"] describe "list" $ do it "simple unordered" $ check "* foo\n\n* bar\n\n*\t\tqux" [ BlockList Unordered (Right [BlockPara "foo"]) , BlockList Unordered (Right [BlockPara "bar"]) , BlockList Unordered (Right [BlockPara "qux"]) ] it "simple ordered" $ check "1. foo\n\n3. bar\n\n17.\t\tqux" [ BlockList Ordered (Right [BlockPara "foo"]) , BlockList Ordered (Right [BlockPara "bar"]) , BlockList Ordered (Right [BlockPara "qux"]) ] it "nested" $ check "* foo\n* \n 1. bar\n 2. baz" [ BlockList Unordered (Left "foo") , BlockList Unordered (Right [ BlockList Ordered $ Left "bar" , BlockList Ordered $ Left "baz" ]) ] it "with blank" $ check "* foo\n\n bar\n\n* baz" [ BlockList Unordered $ Right [ BlockPara "foo" , BlockPara "bar" ] , BlockList Unordered $ Right [ BlockPara "baz" ] ] it "without whitespace" $ check "*foo\n\n1.bar" [ BlockPara "*foo" , BlockPara "1.bar" ] describe "blockquote" $ do it "simple" $ check "> foo\n>\n> * bar" [ BlockQuote [ BlockPara "foo" , BlockList Unordered $ Left "bar" ] ] it "blank" $ check "> foo\n\n> * bar" [ BlockQuote [BlockPara "foo"] , BlockQuote [BlockList Unordered $ Left "bar"] ] it "require blank before blockquote" $ check "foo\n> bar" [ BlockPara "foo\n> bar" ] it "no blank before blockquote" $ checkWith def { msBlankBeforeBlockquote = False } "foo\n> bar" [ BlockPara "foo", BlockQuote [BlockPara "bar"]] describe "indented code" $ do it "simple" $ check " foo\n bar\n" [ BlockCode Nothing "foo\nbar" ] it "blank" $ check " foo\n\n bar\n" [ BlockCode Nothing "foo\n\nbar" ] it "extra space" $ check " foo\n\n bar\n" [ BlockCode Nothing "foo\n\n bar" ] describe "html" $ do it "simple" $ check "Hello world!
" [ BlockHtml "Hello world!
" ] it "multiline" $ check "Hello world!\n
" [ BlockHtml "Hello world!\n
" ] markdown-0.1.17.4/test/Inline.hs 0000644 0000000 0000000 00000006022 12677401324 014511 0 ustar 00 0000000 0000000 {-# LANGUAGE OverloadedStrings #-} module Inline ( inlineSpecs ) where import Test.Hspec import Text.Markdown.Inline import Data.Text (Text) import Data.Monoid (mempty) check :: Text -> [Inline] -> Expectation check md ins = toInline mempty md `shouldBe` ins inlineSpecs :: Spec inlineSpecs = do describe "raw text" $ do it "simple" $ check "raw text" [InlineText "raw text"] it "multiline" $ check "raw\ntext" [InlineText "raw\ntext"] describe "italic" $ do it "asterisk" $ check "raw *text*" [InlineText "raw ", InlineItalic [InlineText "text"]] it "underline" $ check "raw _text_" [InlineText "raw ", InlineItalic [InlineText "text"]] it "multiline" $ check "*raw\ntext*" [InlineItalic [InlineText "raw\ntext"]] it "mismatched" $ check "*foo* *bar" [InlineItalic [InlineText "foo"], InlineText " *bar"] describe "bold" $ do it "asterisk" $ check "raw **text**" [InlineText "raw ", InlineBold [InlineText "text"]] it "underline" $ check "raw __text__" [InlineText "raw ", InlineBold [InlineText "text"]] it "multiline" $ check "**raw\ntext**" [InlineBold [InlineText "raw\ntext"]] it "mismatched" $ check "**foo** *bar" [InlineBold [InlineText "foo"], InlineText " *bar"] describe "nested" $ do it "bold inside italic" $ check "*i __ib__ i*" [InlineItalic [InlineText "i ", InlineBold [InlineText "ib"], InlineText " i"]] it "bold inside italic swap" $ check "_i **ib** i_" [InlineItalic [InlineText "i ", InlineBold [InlineText "ib"], InlineText " i"]] it "italic inside bold" $ check "**b _ib_ b**" [InlineBold [InlineText "b ", InlineItalic [InlineText "ib"], InlineText " b"]] it "italic inside bold swap" $ check "__b *ib* b__" [InlineBold [InlineText "b ", InlineItalic [InlineText "ib"], InlineText " b"]] describe "code" $ do it "takes all characters" $ check "`foo*__*bar` baz`" [ InlineCode "foo*__*bar" , InlineText " baz`" ] describe "escaping" $ do it "asterisk" $ check "\\*foo*\\\\" [InlineText "*foo*\\"] describe "links" $ do it "simple" $ check "[bar](foo)" [InlineLink "foo" Nothing [InlineText "bar"]] it "title" $ check "[bar](foo \"baz\")" [InlineLink "foo" (Just "baz") [InlineText "bar"]] {- it "escaped href" $ check "" "[bar](foo\\) \"baz\")" it "escaped title" $ check "" "[bar](foo\\) \"baz\\\"\")" it "inside a paragraph" $ check "Hello bar World
" "Hello [bar](foo) World" it "not a link" $ check "Not a [ link
" "Not a [ link" -} markdown-0.1.17.4/LICENSE 0000644 0000000 0000000 00000002767 12677401324 013001 0 ustar 00 0000000 0000000 Copyright (c)2011, Michael Snoyman All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Michael Snoyman nor the names of other contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. markdown-0.1.17.4/Setup.hs 0000644 0000000 0000000 00000000056 12677401324 013415 0 ustar 00 0000000 0000000 import Distribution.Simple main = defaultMain markdown-0.1.17.4/markdown.cabal 0000644 0000000 0000000 00000004401 13350667364 014574 0 ustar 00 0000000 0000000 Name: markdown Version: 0.1.17.4 Synopsis: Convert Markdown to HTML, with XSS protection Description: This library leverages existing high-performance libraries (attoparsec, blaze-html, text, and conduit), and should integrate well with existing codebases. Homepage: https://github.com/snoyberg/markdown License: BSD3 License-file: LICENSE Author: Michael Snoyman Maintainer: michael@snoyman.com Category: Web Build-type: Simple Extra-source-files: test/examples/*.html , test/examples/*.md , test/Tests/*.html , test/Tests/*.text , ChangeLog.md , README.md Cabal-version: >=1.8 Library Exposed-modules: Text.Markdown Text.Markdown.Block Text.Markdown.Inline other-modules: Text.Markdown.Types Build-depends: base >= 4.9 && < 5 , blaze-markup >= 0.6 , blaze-html >= 0.4 , attoparsec >= 0.10 , transformers >= 0.2.2 , conduit >= 1.2.8 , conduit-extra >= 1.1 , text , data-default >= 0.3 , xss-sanitize >= 0.3.3 , containers , xml-types , xml-conduit ghc-options: -Wall test-suite test hs-source-dirs: test main-is: main.hs other-modules: Block Inline type: exitcode-stdio-1.0 ghc-options: -Wall build-depends: markdown , base >= 4 && < 5 , hspec >= 1.3 , blaze-html , bytestring , call-stack , text , transformers , conduit , conduit-extra , containers , filepath , directory source-repository head type: git location: git://github.com/snoyberg/markdown.git markdown-0.1.17.4/test/examples/list-blocks.html 0000644 0000000 0000000 00000000311 12677401324 017664 0 ustar 00 0000000 0000000This is a paragraph.
Another paragraph.
Non-paragraph.
Item.
- Sublist item.
- Item 1
- Item 2
foo
barThis is a multiline paragraph.
Multiline paragraph in a list.
The purpose of classy prelude is not to encourage writing polymorphic code based on the typeclasses provided. Though it is certainly possible to write code such as:
| hi |
okay.
markdown-0.1.17.4/test/examples/entities.html 0000644 0000000 0000000 00000000121 12677402753 017270 0 ustar 00 0000000 00000001 < 2 & 2 > 1, also 1 < 2 & 2 > 1  ý &#xP; …
markdown-0.1.17.4/test/examples/sublists.html 0000644 0000000 0000000 00000000143 12677401324 017311 0 ustar 00 0000000 0000000- No encounters
- Encounters
- First kind
- Second kind
Markdown
this is lazy
- This is a list
- Another item
foo
This is a paragraph with double `backtick` inside with space.
This is a paragraph with double `backtick` inside without space.
- hello world
hello
data Foo
Foo
some random code
and other codefoo
bar
baz<!-- foo -->| hi |
markdown-0.1.17.4/test/Tests/Links, shortcut references.html 0000755 0000000 0000000 00000000400 12677401324 022016 0 ustar 00 0000000 0000000foo
bar
foo
This is the simple case.
This one has a line break.
This one has a line break with a line-ending space.
markdown-0.1.17.4/test/Tests/Inline HTML comments.html 0000644 0000000 0000000 00000000274 12677401324 020503 0 ustar 00 0000000 0000000Paragraph one.
Paragraph two.
The end.
markdown-0.1.17.4/test/Tests/Strong and em together.html 0000644 0000000 0000000 00000000247 12677401324 021115 0 ustar 00 0000000 0000000This is strong and em.
So is this word.
This is strong and em.
So is this word.
markdown-0.1.17.4/test/Tests/Inline HTML (Simple).html 0000644 0000000 0000000 00000001430 12677401324 020223 0 ustar 00 0000000 0000000Here's a simple block:
This should be a code block, though:
<div>
foo
</div>
As should this:
<div>foo</div>
Now, nested:
This should just be an HTML comment:
Multiline:
Code block:
<!-- Comment -->
Just plain comment, with trailing spaces on the line:
Code:
<hr />
Hr's:
markdown-0.1.17.4/test/Tests/Tabs.html 0000644 0000000 0000000 00000000667 12677401324 015631 0 ustar 00 0000000 0000000
this is a list item indented with tabs
this is a list item indented with spaces
Code:
this code block is indented by one tab
And:
this code block is indented by two tabs
And:
+ this is an example list item
indented with tabs
+ this is an example list item
indented with spaces
Foo bar.
Foo bar.
Foo bar.
With embedded [brackets].
Indented once.
Indented twice.
Indented thrice.
Indented [four][] times.
[four]: /url
this should work
So should 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 points to something else.
Backslashing should suppress [this] and [this].
Here's one where the link breaks across lines.
Here's another where the link breaks across lines, but with a line-ending space.
markdown-0.1.17.4/test/Tests/Literal quotes in titles.html 0000644 0000000 0000000 00000000243 12677401324 021477 0 ustar 00 0000000 0000000Foo bar.
Foo bar.
markdown-0.1.17.4/test/Tests/Ordered and unordered lists.html 0000644 0000000 0000000 00000003267 12677401324 022135 0 ustar 00 0000000 0000000Unordered
Asterisks tight:
- asterisk 1
- asterisk 2
- asterisk 3
Asterisks loose:
asterisk 1
asterisk 2
asterisk 3
Pluses tight:
- Plus 1
- Plus 2
- Plus 3
Pluses loose:
Plus 1
Plus 2
Plus 3
Minuses tight:
- Minus 1
- Minus 2
- Minus 3
Minuses loose:
Minus 1
Minus 2
Minus 3
Ordered
Tight:
- First
- Second
- Third
and:
- One
- Two
- Three
Loose using tabs:
First
Second
Third
and using spaces:
One
Two
Three
Multiple paragraphs:
Item 1, graf one.
Item 2. graf two. The quick brown fox jumped over the lazy dog's back.
Item 2.
Item 3.
Nested
Tab
Tab
- Tab
Here's another:
- First
- Second:
- Fee
- Fie
- Foe
- Third
Same thing but with paragraphs:
First
Second:
- Fee
- Fie
- Foe
Third
This was an error in Markdown 1.0.1:
this
- sub
that
Dashes:
---
- - -
Asterisks:
***
* * *
Underscores:
___
_ _ _
Inline within a paragraph: alt text.
.
.jpg)
Markdown: Basics
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 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 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.
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 `—`
instead of decimal-encoded entites like `—`.
Output:
<p>I strongly recommend against using any
<code><blink></code> tags.</p>
<p>I wish SmartyPants used named entities like
<code>&mdash;</code> instead of decimal-encoded
entites like <code>&#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><blockquote>
<p>For example.</p>
</blockquote>
</code></pre>
AT&T has an ampersand in their name.
AT&T is another way to write it.
This & that.
4 < 5.
6 > 5.
Here's a link with an ampersand in the URL.
Here's a link with an amersand in the link text: AT&T.
Here's an inline link.
Here's an inline link.
markdown-0.1.17.4/test/Tests/Code Blocks.html 0000644 0000000 0000000 00000000470 12677401324 017000 0 ustar 00 0000000 0000000code 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
Simple block on one line:
And nested without indentation:
And with attributes:
This was broken in 1.0.2b7:
<test a=" content of attribute ">
Fix for backticks within HTML tag: like this
Here's how you put `backticks` in a code span.
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/>
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 bar.
This is a tag with backslashes bar.
markdown-0.1.17.4/test/Tests/Markdown Documentation - Syntax.html 0000644 0000000 0000000 00000076051 12677401324 022700 0 ustar 00 0000000 0000000Markdown: Syntax
Note: This document is itself written using Markdown; you can see the source for it by adding '.text' to the URL.
Overview
Philosophy
Markdown is intended to be as easy-to-read and easy-to-write as is feasible.
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 Setext, atx, Textile, reStructuredText, Grutatext, and EtText -- the single biggest source of inspiration for Markdown's syntax is the format of plain text email.
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.
Inline HTML
Markdown's syntax is intended for one purpose: to be used as a format for writing for the web.
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 not 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 publishing format; Markdown is a writing format. Thus, Markdown's formatting syntax only addresses issues that can be conveyed in plain text.
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.
The only restrictions are that block-level HTML elements -- e.g. <div>,
<table>, <pre>, <p>, 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) <p> tags around HTML block-level tags.
For example, to add an HTML table to a Markdown article:
This is a regular paragraph.
<table>
<tr>
<td>Foo</td>
</tr>
</table>
This is another regular paragraph.
Note that Markdown formatting syntax is not processed within block-level
HTML tags. E.g., you can't use Markdown-style *emphasis* inside an
HTML block.
Span-level HTML tags -- e.g. <span>, <cite>, or <del> -- 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 <a> or <img> tags instead of Markdown's
link or image syntax, go right ahead.
Unlike block-level HTML tags, Markdown syntax is processed within span-level tags.
Automatic Escaping for Special Characters
In HTML, there are two characters that demand special treatment: <
and &. 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. <, and
&.
Ampersands in particular are bedeviling for web writers. If you want to
write about 'AT&T', you need to write 'AT&T'. You even need to
escape ampersands within URLs. Thus, if you want to link to:
http://images.google.com/images?num=30&q=larry+bird
you need to encode the URL as:
http://images.google.com/images?num=30&q=larry+bird
in your anchor tag href 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.
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 &.
So, if you want to include a copyright symbol in your article, you can write:
©
and Markdown will leave it alone. But if you write:
AT&T
Markdown will translate it to:
AT&T
Similarly, because Markdown supports inline HTML, if you use angle brackets as delimiters for HTML tags, Markdown will treat them as such. But if you write:
4 < 5
Markdown will translate it to:
4 < 5
However, inside Markdown code spans and blocks, angle brackets and
ampersands are always 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 <
and & in your example code needs to be escaped.)
Block Elements
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 intended with spaces or tabs.
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 <br /> tag.
When you do want to insert a <br /> break tag using Markdown, you
end a line with two or more spaces, then type return.
Yes, this takes a tad more effort to create a <br />, but a simplistic
"every line break is a <br />" rule wouldn't work for Markdown.
Markdown's email-style blockquoting and multi-paragraph list items
work best -- and look better -- when you format them with hard breaks.
Headers
Markdown supports two styles of headers, Setext and atx.
Setext-style headers are "underlined" using equal signs (for first-level headers) and dashes (for second-level headers). For example:
This is an H1
=============
This is an H2
-------------
Any number of underlining ='s or -'s will work.
Atx-style headers use 1-6 hash characters at the start of the line, corresponding to header levels 1-6. For example:
# This is an H1
## This is an H2
###### This is an H6
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.) :
# This is an H1 #
## This is an H2 ##
### This is an H3 ######
Blockquotes
Markdown uses email-style > 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 > before every line:
> 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.
Markdown allows you to be lazy and only put the > before the first
line of a hard-wrapped paragraph:
> 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.
Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by
adding additional levels of >:
> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.
Blockquotes can contain other Markdown elements, including headers, lists, and code blocks:
> ## 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");
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.
Lists
Markdown supports ordered (numbered) and unordered (bulleted) lists.
Unordered lists use asterisks, pluses, and hyphens -- interchangably -- as list markers:
* Red
* Green
* Blue
is equivalent to:
+ Red
+ Green
+ Blue
and:
- Red
- Green
- Blue
Ordered lists use numbers followed by periods:
1. Bird
2. McHale
3. Parish
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:
<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>
If you instead wrote the list in Markdown like this:
1. Bird
1. McHale
1. Parish
or even:
3. Bird
1. McHale
8. Parish
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.
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.
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.
To make lists look nice, you can wrap items with hanging indents:
* 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.
But if you want to be lazy, you don't have to:
* 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.
If list items are separated by blank lines, Markdown will wrap the
items in <p> tags in the HTML output. For example, this input:
* Bird
* Magic
will turn into:
<ul>
<li>Bird</li>
<li>Magic</li>
</ul>
But this:
* Bird
* Magic
will turn into:
<ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
</ul>
List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be intended by either 4 spaces or one tab:
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.
It looks nice if you indent every line of the subsequent paragraphs, but here again, Markdown will allow you to be lazy:
* 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.
To put a blockquote within a list item, the blockquote's >
delimiters need to be indented:
* A list item with a blockquote:
> This is a blockquote
> inside a list item.
To put a code block within a list item, the code block needs to be indented twice -- 8 spaces or two tabs:
* A list item with a code block:
<code goes here>
It's worth noting that it's possible to trigger an ordered list by accident, by writing something like this:
1986. What a great season.
In other words, a number-period-space sequence at the beginning of a line. To avoid this, you can backslash-escape the period:
1986\. What a great season.
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 <pre> and <code> tags.
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:
This is a normal paragraph:
This is a code block.
Markdown will generate:
<p>This is a normal paragraph:</p>
<pre><code>This is a code block.
</code></pre>
One level of indentation -- 4 spaces or 1 tab -- is removed from each line of the code block. For example, this:
Here is an example of AppleScript:
tell application "Foo"
beep
end tell
will turn into:
<p>Here is an example of AppleScript:</p>
<pre><code>tell application "Foo"
beep
end tell
</code></pre>
A code block continues until it reaches a line that is not indented (or the end of the article).
Within a code block, ampersands (&) and angle brackets (< and >)
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:
<div class="footer">
© 2004 Foo Corporation
</div>
will turn into:
<pre><code><div class="footer">
&copy; 2004 Foo Corporation
</div>
</code></pre>
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.
Horizontal Rules
You can produce a horizontal rule tag (<hr />) 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:
* * *
***
*****
- - -
---------------------------------------
_ _ _
Span Elements
Links
Markdown supports two style of links: inline and reference.
In both styles, the link text is delimited by [square brackets].
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 optional title for the link, surrounded in quotes. For example:
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
Will produce:
<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>
If you're referring to a local resource on the same server, you can use relative paths:
See my [About](/about/) page for details.
Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:
This is [an example][id] reference-style link.
You can optionally use a space to separate the sets of brackets:
This is [an example] [id] reference-style link.
Then, anywhere in the document, you define your link label like this, on a line by itself:
[id]: http://example.com/ "Optional Title Here"
That is:
- Square brackets containing the link identifier (optionally indented from the left margin using up to three spaces);
- followed by a colon;
- followed by one or more spaces (or tabs);
- followed by the URL for the link;
- optionally followed by a title attribute for the link, enclosed in double or single quotes.
The link URL may, optionally, be surrounded by angle brackets:
[id]: <http://example.com/> "Optional Title Here"
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:
[id]: http://example.com/longish/path/to/resource/here
"Optional Title Here"
Link definitions are only used for creating links during Markdown processing, and are stripped from your document in the HTML output.
Link definition names may constist of letters, numbers, spaces, and punctuation -- but they are not case sensitive. E.g. these two links:
[link text][a]
[link text][A]
are equivalent.
The implicit link name 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:
[Google][]
And then define the link:
[Google]: http://google.com/
Because link names may contain spaces, this shortcut even works for multiple words in the link text:
Visit [Daring Fireball][] for more information.
And then define the link:
[Daring Fireball]: http://daringfireball.net/
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.
Here's an example of reference links in action:
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"
Using the implicit link name shortcut, you could instead write:
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"
Both of the above examples will produce the following HTML 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>
For comparison, here is the same paragraph written using Markdown's inline link style:
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").
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.
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.
Emphasis
Markdown treats asterisks (*) and underscores (_) as indicators of
emphasis. Text wrapped with one * or _ will be wrapped with an
HTML <em> tag; double *'s or _'s will be wrapped with an HTML
<strong> tag. E.g., this input:
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
will produce:
<em>single asterisks</em>
<em>single underscores</em>
<strong>double asterisks</strong>
<strong>double underscores</strong>
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.
Emphasis can be used in the middle of a word:
un*fucking*believable
But if you surround an * or _ with spaces, it'll be treated as a
literal asterisk or underscore.
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:
\*this text is surrounded by literal asterisks\*
Code
To indicate a span of code, wrap it with backtick quotes (`).
Unlike a pre-formatted code block, a code span indicates code within a
normal paragraph. For example:
Use the `printf()` function.
will produce:
<p>Use the <code>printf()</code> function.</p>
To include a literal backtick character within a code span, you can use multiple backticks as the opening and closing delimiters:
``There is a literal backtick (`) here.``
which will produce this:
<p><code>There is a literal backtick (`) here.</code></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:
A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``
will produce:
<p>A single backtick in a code span: <code>`</code></p>
<p>A backtick-delimited string in a code span: <code>`foo`</code></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:
Please don't use any `<blink>` tags.
into:
<p>Please don't use any <code><blink></code> tags.</p>
You can write this:
`—` is the decimal-encoded equivalent of `—`.
to produce:
<p><code>&#8212;</code> is the decimal-encoded
equivalent of <code>&mdash;</code>.</p>
Images
Admittedly, it's fairly difficult to devise a "natural" syntax for placing images into a plain text document format.
Markdown uses an image syntax that is intended to resemble the syntax for links, allowing for two styles: inline and reference.
Inline image syntax looks like this:
That is:
- An exclamation mark:
!; - followed by a set of square brackets, containing the
altattribute text for the image; - followed by a set of parentheses, containing the URL or path to
the image, and an optional
titleattribute enclosed in double or single quotes.
Reference-style image syntax looks like this:
![Alt text][id]
Where "id" is the name of a defined image reference. Image references are defined using syntax identical to link references:
[id]: url/to/image "Optional title attribute"
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 <img> tags.
Miscellaneous
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:
<http://example.com/>
Markdown will turn this into:
<a href="http://example.com/">http://example.com/</a>
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:
<address@example.com>
into something like this:
<a href="mailto:addre
ss@example.co
m">address@exa
mple.com</a>
which will render in a browser as a clickable link to "address@example.com".
(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.)
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 <em> tag), you can backslashes
before the asterisks, like this:
\*literal asterisks\*
Markdown provides backslash escapes for the following characters:
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark
Just a URL.
URL wrapped in angle brackets.
URL w/ angle brackets + title.
(With outer parens and parens in url)
(With outer parens and parens in url)
markdown-0.1.17.4/test/Tests/Tidyness.html 0000644 0000000 0000000 00000000205 12677401324 016526 0 ustar 00 0000000 0000000markdown-0.1.17.4/test/Tests/Hard-wrapped paragraphs with list-like lines.html 0000644 0000000 0000000 00000000327 12677401324 025265 0 ustar 00 0000000 0000000A list within a blockquote:
- asterisk 1
- asterisk 2
- asterisk 3
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.
markdown-0.1.17.4/test/Tests/Blockquotes with code blocks.html 0000644 0000000 0000000 00000000310 12677401324 022301 0 ustar 00 0000000 0000000markdown-0.1.17.4/test/Tests/Amps and angle encoding.text 0000644 0000000 0000000 00000000576 12677401324 021220 0 ustar 00 0000000 0000000 AT&T has an ampersand in their name. AT&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](). [1]: http://example.com/?foo=1&bar=2 [2]: http://att.com/ "AT&T" markdown-0.1.17.4/test/Tests/Code Blocks.text 0000644 0000000 0000000 00000000307 12677401324 017017 0 ustar 00 0000000 0000000 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 markdown-0.1.17.4/test/Tests/Horizontal rules.text 0000644 0000000 0000000 00000000416 12677401324 020214 0 ustar 00 0000000 0000000 Dashes: --- --- --- --- --- - - - - - - - - - - - - - - - Asterisks: *** *** *** *** *** * * * * * * * * * * * * * * * Underscores: ___ ___ ___ ___ ___ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ markdown-0.1.17.4/test/Tests/Images.text 0000644 0000000 0000000 00000000670 12677401324 016157 0 ustar 00 0000000 0000000   Inline within a paragraph: [alt text](/url/).   ![alt text]() ![alt text]( "with a title"). ![Empty]() .jpg) ![alt text][foo] [foo]: /url/ ![alt text][bar] [bar]: /url/ "Title here" markdown-0.1.17.4/test/Tests/Tidyness.text 0000644 0000000 0000000 00000000116 12677401324 016547 0 ustar 00 0000000 0000000 > A list within a blockquote: > > * asterisk 1 > * asterisk 2 > * asterisk 3 markdown-0.1.17.4/test/Tests/Hard-wrapped paragraphs with list-like lines.text 0000644 0000000 0000000 00000000305 12677401324 025301 0 ustar 00 0000000 0000000 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. markdown-0.1.17.4/test/Tests/Blockquotes with code blocks.text 0000644 0000000 0000000 00000000207 12677401324 022326 0 ustar 00 0000000 0000000 > Example: > > sub status { > print "working"; > } > > Or: > > sub status { > return "working"; > } markdown-0.1.17.4/test/Tests/Inline HTML (Advanced).text 0000644 0000000 0000000 00000000470 12677401324 020522 0 ustar 00 0000000 0000000 Simple block on one line:Example:
sub status { print "working"; }Or:
sub status { return "working"; }
Hr's:
markdown-0.1.17.4/test/Tests/Nested blockquotes.text 0000644 0000000 0000000 00000000030 12677401324 020476 0 ustar 00 0000000 0000000 > foo > > > bar > > foo markdown-0.1.17.4/test/Tests/Links, shortcut references.text 0000755 0000000 0000000 00000000354 12677401324 022046 0 ustar 00 0000000 0000000 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 markdown-0.1.17.4/test/Tests/Literal quotes in titles.text 0000644 0000000 0000000 00000000154 12677401324 021520 0 ustar 00 0000000 0000000 Foo [bar][]. Foo [bar](/url/ "Title with "quotes" inside"). [bar]: /url/ "Title with "quotes" inside" markdown-0.1.17.4/test/Tests/Tabs.text 0000644 0000000 0000000 00000000467 12677401324 015647 0 ustar 00 0000000 0000000 + this is a list item indented with tabs + this is a list item indented with spaces Code: this code block is indented by one tab And: this code block is indented by two tabs And: + this is an example list item indented with tabs + this is an example list item indented with spaces markdown-0.1.17.4/test/Tests/Links, reference style.text 0000644 0000000 0000000 00000001427 12677401324 021147 0 ustar 00 0000000 0000000 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/ markdown-0.1.17.4/ChangeLog.md 0000644 0000000 0000000 00000001176 13350667405 014141 0 ustar 00 0000000 0000000 # Changelog for markdown ## 0.1.17.4 * One more fix for test suite, now works on Windows as well ## 0.1.17.3 * Fix the previous test fix ## 0.1.17.2 * Make test suite slightly more resilient to escaping rules ## 0.1.17.1 * Remove `OPTIONS_HADDOCK hide` ## 0.1.17 * Support GHC 8.4.1 ## 0.1.16 * Add `setNoFollowExternal` ## 0.1.15 * defaultMarkdownSettings ## 0.1.14 * Handle named entities [#30](https://github.com/snoyberg/markdown/issues/30) ## 0.1.13.2 * Drop system-filepath ## 0.1.13.1 Fixes for GHC 7.10 ## 0.1.13 Add `msAddHeadingId`. ## 0.1.12 Support for two spaces at end of line to create a linebreak. markdown-0.1.17.4/README.md 0000644 0000000 0000000 00000001104 13350611524 013225 0 ustar 00 0000000 0000000 ## Markdown for haskell **NOTE** This package is deprecated and no longer supported. Instead, please consider using [cmark] or [cmark-gfm]. This is a haskell library for converting markdown to HTML. It's written in pure haskell. Also read the more technical description on [stackage]. ### Use with yesod For use with yesod, check out [yesod-text-markdown][ytm]. [cmark]: https://www.stackage.org/package/cmark [cmark-gfm]: https://www.stackage.org/package/cmark-gfm [stackage]: https://www.stackage.org/package/markdown [ytm]: https://github.com/Tarrasch/yesod-text-markdown