Modulecmark-gfm-0.2.6Haskell2010

CMarkGFM

13 types
21 values

Packagecmark-gfm-0.2.6
Exports34
LanguageHaskell2010
LicenceBSD-3-Clause
SourceCMarkGFM.hsc

valuecommonmarkToHtml :: [CMarkOption] -> [CMarkExtension] -> Text -> Text

Convert CommonMark formatted text to Html, using cmark's built-in renderer.

valuecommonmarkToXml :: [CMarkOption] -> [CMarkExtension] -> Text -> Text

Convert CommonMark formatted text to CommonMark XML, using cmark's built-in renderer.

valuecommonmarkToMan

:: [CMarkOption]
-> [CMarkExtension]
-> Maybe Int
-> Text
-> Text

Convert CommonMark formatted text to groff man, using cmark's built-in renderer.

valuecommonmarkToLaTeX

:: [CMarkOption]
-> [CMarkExtension]
-> Maybe Int
-> Text
-> Text

Convert CommonMark formatted text to latex, using cmark's built-in renderer.

valuecommonmarkToNode :: [CMarkOption] -> [CMarkExtension] -> Text -> Node

Convert CommonMark formatted text to a structured Node tree, which can be transformed or rendered using Haskell code.

valuenodeToHtml :: [CMarkOption] -> [CMarkExtension] -> Node -> Text

valuenodeToXml :: [CMarkOption] -> Node -> Text

valuenodeToMan :: [CMarkOption] -> Maybe Int -> Node -> Text

valuenodeToLaTeX :: [CMarkOption] -> Maybe Int -> Node -> Text

valuenodeToCommonmark :: [CMarkOption] -> Maybe Int -> Node -> Text

valueoptSourcePos :: CMarkOption

Include a data-sourcepos attribute on block elements.

valueoptHardBreaks :: CMarkOption

Render softbreak elements as hard line breaks.

valueoptSmart :: CMarkOption

Convert straight quotes to curly, --- to em-dash, -- to en-dash.

valueoptSafe :: 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.

valueoptUnsafe :: CMarkOption

Allow rendering of raw HTML and potentially dangerous URLs in links and images.

valueoptFootnotes :: CMarkOption

Enable footnote syntax support (equivalent of footnotes extension for official cmark-gfm)

valueextStrikethrough :: CMarkExtension

valueextTable :: CMarkExtension

valueextAutolink :: CMarkExtension

valueextTagfilter :: CMarkExtension

valueextTaskList :: CMarkExtension

datadata Node

Constructors

Node (Maybe PosInfo) NodeType [Node]

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq NodeDefined in cmark-gfm-0.2.6 · CMarkGFM
Data NodeDefined in cmark-gfm-0.2.6 · CMarkGFM
Ord NodeDefined in cmark-gfm-0.2.6 · CMarkGFM
Read NodeDefined in cmark-gfm-0.2.6 · CMarkGFM
Show NodeDefined in cmark-gfm-0.2.6 · CMarkGFM
Generic NodeDefined in cmark-gfm-0.2.6 · CMarkGFM
type Rep Node = D1 ('MetaData "Node" "CMarkGFM" "cmark-gfm-0.2.6-AppPtIIW2Qf77EDrWwMjiS" 'False) (C1 ('MetaCons "Node" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PosInfo)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodeType) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Node]))))Defined in cmark-gfm-0.2.6 · CMarkGFM

datadata NodeType

Constructors

DOCUMENT
THEMATIC_BREAK
PARAGRAPH
BLOCK_QUOTE
HTML_BLOCK Text
CUSTOM_BLOCK OnEnter OnExit
CODE_BLOCK Info Text
HEADING Level
LIST ListAttributes
ITEM
TEXT Text
SOFTBREAK
LINEBREAK
HTML_INLINE Text
CUSTOM_INLINE OnEnter OnExit
CODE Text
EMPH
STRONG
LINK Url Title
IMAGE Url Title
STRIKETHROUGH
TABLE [TableCellAlignment]
TABLE_ROW
TABLE_CELL
FOOTNOTE_REFERENCE
FOOTNOTE_DEFINITION

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq NodeTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Data NodeTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Ord NodeTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Read NodeTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Show NodeTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Generic NodeTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
type Rep NodeType = D1 ('MetaData "NodeType" "CMarkGFM" "cmark-gfm-0.2.6-AppPtIIW2Qf77EDrWwMjiS" 'False) ((((C1 ('MetaCons "DOCUMENT" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "THEMATIC_BREAK" 'PrefixI 'False) U1 :+: C1 ('MetaCons "PARAGRAPH" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "BLOCK_QUOTE" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "HTML_BLOCK" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "CUSTOM_BLOCK" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OnEnter) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OnExit))))) :+: ((C1 ('MetaCons "CODE_BLOCK" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Info) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "HEADING" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Level)) :+: C1 ('MetaCons "LIST" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ListAttributes)))) :+: ((C1 ('MetaCons "ITEM" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TEXT" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :+: (C1 ('MetaCons "SOFTBREAK" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LINEBREAK" 'PrefixI 'False) U1)))) :+: (((C1 ('MetaCons "HTML_INLINE" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "CUSTOM_INLINE" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OnEnter) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OnExit)) :+: C1 ('MetaCons "CODE" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: (C1 ('MetaCons "EMPH" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "STRONG" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LINK" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Url) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Title))))) :+: ((C1 ('MetaCons "IMAGE" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Url) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Title)) :+: (C1 ('MetaCons "STRIKETHROUGH" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TABLE" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TableCellAlignment])))) :+: ((C1 ('MetaCons "TABLE_ROW" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TABLE_CELL" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "FOOTNOTE_REFERENCE" 'PrefixI 'False) U1 :+: C1 ('MetaCons "FOOTNOTE_DEFINITION" 'PrefixI 'False) U1)))))Defined in cmark-gfm-0.2.6 · CMarkGFM

datadata PosInfo

Constructors

PosInfo
- startLine :: Int
- startColumn :: Int
- endLine :: Int
- endColumn :: Int

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq PosInfoDefined in cmark-gfm-0.2.6 · CMarkGFM
Data PosInfoDefined in cmark-gfm-0.2.6 · CMarkGFM
Ord PosInfoDefined in cmark-gfm-0.2.6 · CMarkGFM
Read PosInfoDefined in cmark-gfm-0.2.6 · CMarkGFM
Show PosInfoDefined in cmark-gfm-0.2.6 · CMarkGFM
Generic PosInfoDefined in cmark-gfm-0.2.6 · CMarkGFM
type Rep PosInfo = D1 ('MetaData "PosInfo" "CMarkGFM" "cmark-gfm-0.2.6-AppPtIIW2Qf77EDrWwMjiS" 'False) (C1 ('MetaCons "PosInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "startLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "startColumn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "endLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "endColumn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))Defined in cmark-gfm-0.2.6 · CMarkGFM

datadata DelimType

PERIOD_DELIM PAREN_DELIM

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq DelimTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Data DelimTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Ord DelimTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Read DelimTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Show DelimTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Generic DelimTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
type Rep DelimType = D1 ('MetaData "DelimType" "CMarkGFM" "cmark-gfm-0.2.6-AppPtIIW2Qf77EDrWwMjiS" 'False) (C1 ('MetaCons "PERIOD_DELIM" 'PrefixI 'False) U1 :+: C1 ('MetaCons "PAREN_DELIM" 'PrefixI 'False) U1)Defined in cmark-gfm-0.2.6 · CMarkGFM

datadata ListType

BULLET_LIST ORDERED_LIST

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq ListTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Data ListTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Ord ListTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Read ListTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Show ListTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
Generic ListTypeDefined in cmark-gfm-0.2.6 · CMarkGFM
type Rep ListType = D1 ('MetaData "ListType" "CMarkGFM" "cmark-gfm-0.2.6-AppPtIIW2Qf77EDrWwMjiS" 'False) (C1 ('MetaCons "BULLET_LIST" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ORDERED_LIST" 'PrefixI 'False) U1)Defined in cmark-gfm-0.2.6 · CMarkGFM

datadata ListAttributes

Constructors

ListAttributes
- listType :: ListType
- listTight :: Bool
- listStart :: Int
- listDelim :: DelimType

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq ListAttributesDefined in cmark-gfm-0.2.6 · CMarkGFM
Data ListAttributesDefined in cmark-gfm-0.2.6 · CMarkGFM
Ord ListAttributesDefined in cmark-gfm-0.2.6 · CMarkGFM
Read ListAttributesDefined in cmark-gfm-0.2.6 · CMarkGFM
Show ListAttributesDefined in cmark-gfm-0.2.6 · CMarkGFM
Generic ListAttributesDefined in cmark-gfm-0.2.6 · CMarkGFM
type Rep ListAttributes = D1 ('MetaData "ListAttributes" "CMarkGFM" "cmark-gfm-0.2.6-AppPtIIW2Qf77EDrWwMjiS" 'False) (C1 ('MetaCons "ListAttributes" 'PrefixI 'True) ((S1 ('MetaSel ('Just "listType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ListType) :*: S1 ('MetaSel ('Just "listTight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "listStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "listDelim") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DelimType))))Defined in cmark-gfm-0.2.6 · CMarkGFM

typetype Url = Text

typetype Title = Text

typetype Level = Int

typetype Info = Text

datadata TableCellAlignment

NoAlignment LeftAligned CenterAligned RightAligned

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq TableCellAlignmentDefined in cmark-gfm-0.2.6 · CMarkGFM
Data TableCellAlignmentDefined in cmark-gfm-0.2.6 · CMarkGFM
Ord TableCellAlignmentDefined in cmark-gfm-0.2.6 · CMarkGFM
Read TableCellAlignmentDefined in cmark-gfm-0.2.6 · CMarkGFM
Show TableCellAlignmentDefined in cmark-gfm-0.2.6 · CMarkGFM
Generic TableCellAlignmentDefined in cmark-gfm-0.2.6 · CMarkGFM
type Rep TableCellAlignment = D1 ('MetaData "TableCellAlignment" "CMarkGFM" "cmark-gfm-0.2.6-AppPtIIW2Qf77EDrWwMjiS" 'False) ((C1 ('MetaCons "NoAlignment" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LeftAligned" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "CenterAligned" 'PrefixI 'False) U1 :+: C1 ('MetaCons "RightAligned" 'PrefixI 'False) U1))Defined in cmark-gfm-0.2.6 · CMarkGFM

newtypenewtype CMarkOption

newtypenewtype CMarkExtension