-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Fast, accurate CommonMark (Markdown) parser and renderer
--   
--   This package provides Haskell bindings for <a>libcmark</a>, the
--   reference parser for <a>CommonMark</a>, a fully specified variant of
--   Markdown. It includes sources for libcmark (0.26.0) and does not
--   require prior installation of the C library.
@package cmark
@version 0.5.4

module CMark

-- | Convert CommonMark formatted text to Html, using cmark's built-in
--   renderer.
commonmarkToHtml :: [CMarkOption] -> Text -> Text

-- | Convert CommonMark formatted text to CommonMark XML, using cmark's
--   built-in renderer.
commonmarkToXml :: [CMarkOption] -> Text -> Text

-- | Convert CommonMark formatted text to groff man, using cmark's built-in
--   renderer.
commonmarkToMan :: [CMarkOption] -> Maybe Int -> Text -> Text

-- | Convert CommonMark formatted text to latex, using cmark's built-in
--   renderer.
commonmarkToLaTeX :: [CMarkOption] -> Maybe Int -> Text -> Text

-- | Convert CommonMark formatted text to a structured <a>Node</a> tree,
--   which can be transformed or rendered using Haskell code.
commonmarkToNode :: [CMarkOption] -> Text -> Node
nodeToHtml :: [CMarkOption] -> Node -> Text
nodeToXml :: [CMarkOption] -> Node -> Text
nodeToMan :: [CMarkOption] -> Maybe Int -> Node -> Text
nodeToLaTeX :: [CMarkOption] -> Maybe Int -> Node -> Text
nodeToCommonmark :: [CMarkOption] -> Maybe Int -> Node -> Text

-- | Include a <tt>data-sourcepos</tt> attribute on block elements.
optSourcePos :: CMarkOption

-- | Normalize the document by consolidating adjacent text nodes.
optNormalize :: CMarkOption

-- | Render <tt>softbreak</tt> elements as hard line breaks.
optHardBreaks :: CMarkOption

-- | Convert straight quotes to curly, <tt>---</tt> to em-dash, <tt>--</tt>
--   to en-dash.
optSmart :: CMarkOption

-- | Suppress rendering of raw HTML and potentially dangerous URLs in links
--   and images.
optSafe :: CMarkOption
data Node
Node :: (Maybe PosInfo) -> NodeType -> [Node] -> Node
data NodeType
DOCUMENT :: NodeType
THEMATIC_BREAK :: NodeType
PARAGRAPH :: NodeType
BLOCK_QUOTE :: NodeType
HTML_BLOCK :: Text -> NodeType
CUSTOM_BLOCK :: OnEnter -> OnExit -> NodeType
CODE_BLOCK :: Info -> Text -> NodeType
HEADING :: Level -> NodeType
LIST :: ListAttributes -> NodeType
ITEM :: NodeType
TEXT :: Text -> NodeType
SOFTBREAK :: NodeType
LINEBREAK :: NodeType
HTML_INLINE :: Text -> NodeType
CUSTOM_INLINE :: OnEnter -> OnExit -> NodeType
CODE :: Text -> NodeType
EMPH :: NodeType
STRONG :: NodeType
LINK :: Url -> Title -> NodeType
IMAGE :: Url -> Title -> NodeType
data PosInfo
PosInfo :: Int -> Int -> Int -> Int -> PosInfo
[startLine] :: PosInfo -> Int
[startColumn] :: PosInfo -> Int
[endLine] :: PosInfo -> Int
[endColumn] :: PosInfo -> Int
data DelimType
PERIOD_DELIM :: DelimType
PAREN_DELIM :: DelimType
data ListType
BULLET_LIST :: ListType
ORDERED_LIST :: ListType
data ListAttributes
ListAttributes :: ListType -> Bool -> Int -> DelimType -> ListAttributes
[listType] :: ListAttributes -> ListType
[listTight] :: ListAttributes -> Bool
[listStart] :: ListAttributes -> Int
[listDelim] :: ListAttributes -> DelimType
type Url = Text
type Title = Text
type Level = Int
type Info = Text
data CMarkOption
instance GHC.Generics.Generic CMark.Node
instance Data.Data.Data CMark.Node
instance GHC.Classes.Ord CMark.Node
instance GHC.Classes.Eq CMark.Node
instance GHC.Read.Read CMark.Node
instance GHC.Show.Show CMark.Node
instance GHC.Generics.Generic CMark.PosInfo
instance Data.Data.Data CMark.PosInfo
instance GHC.Classes.Ord CMark.PosInfo
instance GHC.Classes.Eq CMark.PosInfo
instance GHC.Read.Read CMark.PosInfo
instance GHC.Show.Show CMark.PosInfo
instance GHC.Generics.Generic CMark.NodeType
instance Data.Data.Data CMark.NodeType
instance GHC.Classes.Ord CMark.NodeType
instance GHC.Classes.Eq CMark.NodeType
instance GHC.Read.Read CMark.NodeType
instance GHC.Show.Show CMark.NodeType
instance GHC.Generics.Generic CMark.ListAttributes
instance Data.Data.Data CMark.ListAttributes
instance GHC.Classes.Ord CMark.ListAttributes
instance GHC.Classes.Eq CMark.ListAttributes
instance GHC.Read.Read CMark.ListAttributes
instance GHC.Show.Show CMark.ListAttributes
instance GHC.Generics.Generic CMark.ListType
instance Data.Data.Data CMark.ListType
instance GHC.Classes.Ord CMark.ListType
instance GHC.Classes.Eq CMark.ListType
instance GHC.Read.Read CMark.ListType
instance GHC.Show.Show CMark.ListType
instance GHC.Generics.Generic CMark.DelimType
instance Data.Data.Data CMark.DelimType
instance GHC.Classes.Ord CMark.DelimType
instance GHC.Classes.Eq CMark.DelimType
instance GHC.Read.Read CMark.DelimType
instance GHC.Show.Show CMark.DelimType
