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

-- | Fast, accurate GitHub Flavored Markdown parser and renderer
--   
--   This package provides Haskell bindings for libcmark-gfm, the
--   reference parser for GitHub Flavored Markdown, a fully
--   specified variant of Markdown. It includes sources for libcmark-gfm
--   (0.29.0.gfm.13) and does not require prior installation of the C
--   library.
@package cmark-gfm
@version 0.2.6

module CMarkGFM

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

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

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

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

-- | Convert CommonMark formatted text to a structured Node tree,
--   which can be transformed or rendered using Haskell code.
commonmarkToNode :: [CMarkOption] -> [CMarkExtension] -> Text -> Node
nodeToHtml :: [CMarkOption] -> [CMarkExtension] -> 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 data-sourcepos attribute on block elements.
optSourcePos :: CMarkOption

-- | Render softbreak elements as hard line breaks.
optHardBreaks :: CMarkOption

-- | Convert straight quotes to curly, --- to em-dash, --
--   to en-dash.
optSmart :: CMarkOption

-- | optSafe is defined here for API compatibility, but it no longer has
--   any effect. Safe mode is now the default: set optUnsafe to
--   disable it.
optSafe :: CMarkOption

-- | Allow rendering of raw HTML and potentially dangerous URLs in links
--   and images.
optUnsafe :: CMarkOption

-- | Enable footnote syntax support (equivalent of footnotes extension for
--   official cmark-gfm)
optFootnotes :: CMarkOption
extStrikethrough :: CMarkExtension
extTable :: CMarkExtension
extAutolink :: CMarkExtension
extTagfilter :: CMarkExtension
extTaskList :: CMarkExtension
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
STRIKETHROUGH :: NodeType
TABLE :: [TableCellAlignment] -> NodeType
TABLE_ROW :: NodeType
TABLE_CELL :: NodeType
FOOTNOTE_REFERENCE :: NodeType
FOOTNOTE_DEFINITION :: 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 TableCellAlignment
NoAlignment :: TableCellAlignment
LeftAligned :: TableCellAlignment
CenterAligned :: TableCellAlignment
RightAligned :: TableCellAlignment
data CMarkOption
data CMarkExtension
instance GHC.Generics.Generic CMarkGFM.DelimType
instance Data.Data.Data CMarkGFM.DelimType
instance GHC.Classes.Ord CMarkGFM.DelimType
instance GHC.Classes.Eq CMarkGFM.DelimType
instance GHC.Read.Read CMarkGFM.DelimType
instance GHC.Show.Show CMarkGFM.DelimType
instance GHC.Generics.Generic CMarkGFM.ListType
instance Data.Data.Data CMarkGFM.ListType
instance GHC.Classes.Ord CMarkGFM.ListType
instance GHC.Classes.Eq CMarkGFM.ListType
instance GHC.Read.Read CMarkGFM.ListType
instance GHC.Show.Show CMarkGFM.ListType
instance GHC.Generics.Generic CMarkGFM.ListAttributes
instance Data.Data.Data CMarkGFM.ListAttributes
instance GHC.Classes.Ord CMarkGFM.ListAttributes
instance GHC.Classes.Eq CMarkGFM.ListAttributes
instance GHC.Read.Read CMarkGFM.ListAttributes
instance GHC.Show.Show CMarkGFM.ListAttributes
instance GHC.Generics.Generic CMarkGFM.TableCellAlignment
instance Data.Data.Data CMarkGFM.TableCellAlignment
instance GHC.Classes.Ord CMarkGFM.TableCellAlignment
instance GHC.Classes.Eq CMarkGFM.TableCellAlignment
instance GHC.Read.Read CMarkGFM.TableCellAlignment
instance GHC.Show.Show CMarkGFM.TableCellAlignment
instance GHC.Generics.Generic CMarkGFM.NodeType
instance Data.Data.Data CMarkGFM.NodeType
instance GHC.Classes.Ord CMarkGFM.NodeType
instance GHC.Classes.Eq CMarkGFM.NodeType
instance GHC.Read.Read CMarkGFM.NodeType
instance GHC.Show.Show CMarkGFM.NodeType
instance GHC.Generics.Generic CMarkGFM.PosInfo
instance Data.Data.Data CMarkGFM.PosInfo
instance GHC.Classes.Ord CMarkGFM.PosInfo
instance GHC.Classes.Eq CMarkGFM.PosInfo
instance GHC.Read.Read CMarkGFM.PosInfo
instance GHC.Show.Show CMarkGFM.PosInfo
instance GHC.Generics.Generic CMarkGFM.Node
instance Data.Data.Data CMarkGFM.Node
instance GHC.Classes.Ord CMarkGFM.Node
instance GHC.Classes.Eq CMarkGFM.Node
instance GHC.Read.Read CMarkGFM.Node
instance GHC.Show.Show CMarkGFM.Node
