cmark-gfm-0.2.6: Fast, accurate GitHub Flavored Markdown parser and renderer
Safe HaskellNone
LanguageHaskell2010

CMarkGFM

Synopsis

Documentation

commonmarkToHtml :: [CMarkOption] -> [CMarkExtension] -> Text -> Text Source #

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

commonmarkToXml :: [CMarkOption] -> [CMarkExtension] -> Text -> Text Source #

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

commonmarkToMan :: [CMarkOption] -> [CMarkExtension] -> Maybe Int -> Text -> Text Source #

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

commonmarkToLaTeX :: [CMarkOption] -> [CMarkExtension] -> Maybe Int -> Text -> Text Source #

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

commonmarkToNode :: [CMarkOption] -> [CMarkExtension] -> Text -> Node Source #

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

optSourcePos :: CMarkOption Source #

Include a data-sourcepos attribute on block elements.

optHardBreaks :: CMarkOption Source #

Render softbreak elements as hard line breaks.

optSmart :: CMarkOption Source #

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

optSafe :: CMarkOption Source #

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.

optUnsafe :: CMarkOption Source #

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

optFootnotes :: CMarkOption Source #

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

data Node Source #

Constructors

Node (Maybe PosInfo) NodeType [Node] 

Instances

Instances details
Data Node Source # 
Instance details

Defined in CMarkGFM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Node -> c Node #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Node #

toConstr :: Node -> Constr #

dataTypeOf :: Node -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Node) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Node) #

gmapT :: (forall b. Data b => b -> b) -> Node -> Node #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r #

gmapQ :: (forall d. Data d => d -> u) -> Node -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Node -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Node -> m Node #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node #

Generic Node Source # 
Instance details

Defined in CMarkGFM

Associated Types

type Rep Node :: Type -> Type #

Methods

from :: Node -> Rep Node x #

to :: Rep Node x -> Node #

Read Node Source # 
Instance details

Defined in CMarkGFM

Show Node Source # 
Instance details

Defined in CMarkGFM

Methods

showsPrec :: Int -> Node -> ShowS #

show :: Node -> String #

showList :: [Node] -> ShowS #

Eq Node Source # 
Instance details

Defined in CMarkGFM

Methods

(==) :: Node -> Node -> Bool #

(/=) :: Node -> Node -> Bool #

Ord Node Source # 
Instance details

Defined in CMarkGFM

Methods

compare :: Node -> Node -> Ordering #

(<) :: Node -> Node -> Bool #

(<=) :: Node -> Node -> Bool #

(>) :: Node -> Node -> Bool #

(>=) :: Node -> Node -> Bool #

max :: Node -> Node -> Node #

min :: Node -> Node -> Node #

type Rep Node Source # 
Instance details

Defined in CMarkGFM

data NodeType Source #

Instances

Instances details
Data NodeType Source # 
Instance details

Defined in CMarkGFM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NodeType -> c NodeType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NodeType #

toConstr :: NodeType -> Constr #

dataTypeOf :: NodeType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NodeType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NodeType) #

gmapT :: (forall b. Data b => b -> b) -> NodeType -> NodeType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NodeType -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NodeType -> r #

gmapQ :: (forall d. Data d => d -> u) -> NodeType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> NodeType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NodeType -> m NodeType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NodeType -> m NodeType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NodeType -> m NodeType #

Generic NodeType Source # 
Instance details

Defined in CMarkGFM

Associated Types

type Rep NodeType :: Type -> Type #

Methods

from :: NodeType -> Rep NodeType x #

to :: Rep NodeType x -> NodeType #

Read NodeType Source # 
Instance details

Defined in CMarkGFM

Show NodeType Source # 
Instance details

Defined in CMarkGFM

Eq NodeType Source # 
Instance details

Defined in CMarkGFM

Ord NodeType Source # 
Instance details

Defined in CMarkGFM

type Rep NodeType Source # 
Instance details

Defined in CMarkGFM

data PosInfo Source #

Constructors

PosInfo 

Instances

Instances details
Data PosInfo Source # 
Instance details

Defined in CMarkGFM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PosInfo -> c PosInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PosInfo #

toConstr :: PosInfo -> Constr #

dataTypeOf :: PosInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PosInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PosInfo) #

gmapT :: (forall b. Data b => b -> b) -> PosInfo -> PosInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PosInfo -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PosInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> PosInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PosInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PosInfo -> m PosInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PosInfo -> m PosInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PosInfo -> m PosInfo #

Generic PosInfo Source # 
Instance details

Defined in CMarkGFM

Associated Types

type Rep PosInfo :: Type -> Type #

Methods

from :: PosInfo -> Rep PosInfo x #

to :: Rep PosInfo x -> PosInfo #

Read PosInfo Source # 
Instance details

Defined in CMarkGFM

Show PosInfo Source # 
Instance details

Defined in CMarkGFM

Eq PosInfo Source # 
Instance details

Defined in CMarkGFM

Methods

(==) :: PosInfo -> PosInfo -> Bool #

(/=) :: PosInfo -> PosInfo -> Bool #

Ord PosInfo Source # 
Instance details

Defined in CMarkGFM

type Rep PosInfo Source # 
Instance details

Defined in CMarkGFM

type Rep PosInfo = D1 ('MetaData "PosInfo" "CMarkGFM" "cmark-gfm-0.2.6-G3rZtSwpqpk8LVz00lSWZb" '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))))

data DelimType Source #

Constructors

PERIOD_DELIM 
PAREN_DELIM 

Instances

Instances details
Data DelimType Source # 
Instance details

Defined in CMarkGFM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DelimType -> c DelimType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DelimType #

toConstr :: DelimType -> Constr #

dataTypeOf :: DelimType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DelimType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DelimType) #

gmapT :: (forall b. Data b => b -> b) -> DelimType -> DelimType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DelimType -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DelimType -> r #

gmapQ :: (forall d. Data d => d -> u) -> DelimType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DelimType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DelimType -> m DelimType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DelimType -> m DelimType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DelimType -> m DelimType #

Generic DelimType Source # 
Instance details

Defined in CMarkGFM

Associated Types

type Rep DelimType :: Type -> Type #

Read DelimType Source # 
Instance details

Defined in CMarkGFM

Show DelimType Source # 
Instance details

Defined in CMarkGFM

Eq DelimType Source # 
Instance details

Defined in CMarkGFM

Ord DelimType Source # 
Instance details

Defined in CMarkGFM

type Rep DelimType Source # 
Instance details

Defined in CMarkGFM

type Rep DelimType = D1 ('MetaData "DelimType" "CMarkGFM" "cmark-gfm-0.2.6-G3rZtSwpqpk8LVz00lSWZb" 'False) (C1 ('MetaCons "PERIOD_DELIM" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PAREN_DELIM" 'PrefixI 'False) (U1 :: Type -> Type))

data ListType Source #

Constructors

BULLET_LIST 
ORDERED_LIST 

Instances

Instances details
Data ListType Source # 
Instance details

Defined in CMarkGFM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListType -> c ListType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListType #

toConstr :: ListType -> Constr #

dataTypeOf :: ListType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListType) #

gmapT :: (forall b. Data b => b -> b) -> ListType -> ListType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListType -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListType -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListType -> m ListType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListType -> m ListType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListType -> m ListType #

Generic ListType Source # 
Instance details

Defined in CMarkGFM

Associated Types

type Rep ListType :: Type -> Type #

Methods

from :: ListType -> Rep ListType x #

to :: Rep ListType x -> ListType #

Read ListType Source # 
Instance details

Defined in CMarkGFM

Show ListType Source # 
Instance details

Defined in CMarkGFM

Eq ListType Source # 
Instance details

Defined in CMarkGFM

Ord ListType Source # 
Instance details

Defined in CMarkGFM

type Rep ListType Source # 
Instance details

Defined in CMarkGFM

type Rep ListType = D1 ('MetaData "ListType" "CMarkGFM" "cmark-gfm-0.2.6-G3rZtSwpqpk8LVz00lSWZb" 'False) (C1 ('MetaCons "BULLET_LIST" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ORDERED_LIST" 'PrefixI 'False) (U1 :: Type -> Type))

data ListAttributes Source #

Instances

Instances details
Data ListAttributes Source # 
Instance details

Defined in CMarkGFM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListAttributes -> c ListAttributes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListAttributes #

toConstr :: ListAttributes -> Constr #

dataTypeOf :: ListAttributes -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListAttributes) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListAttributes) #

gmapT :: (forall b. Data b => b -> b) -> ListAttributes -> ListAttributes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListAttributes -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListAttributes -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListAttributes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListAttributes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListAttributes -> m ListAttributes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListAttributes -> m ListAttributes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListAttributes -> m ListAttributes #

Generic ListAttributes Source # 
Instance details

Defined in CMarkGFM

Associated Types

type Rep ListAttributes :: Type -> Type #

Read ListAttributes Source # 
Instance details

Defined in CMarkGFM

Show ListAttributes Source # 
Instance details

Defined in CMarkGFM

Eq ListAttributes Source # 
Instance details

Defined in CMarkGFM

Ord ListAttributes Source # 
Instance details

Defined in CMarkGFM

type Rep ListAttributes Source # 
Instance details

Defined in CMarkGFM

type Rep ListAttributes = D1 ('MetaData "ListAttributes" "CMarkGFM" "cmark-gfm-0.2.6-G3rZtSwpqpk8LVz00lSWZb" '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))))

type Url = Text Source #

type Level = Int Source #

type Info = Text Source #

data TableCellAlignment Source #

Instances

Instances details
Data TableCellAlignment Source # 
Instance details

Defined in CMarkGFM

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TableCellAlignment -> c TableCellAlignment #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TableCellAlignment #

toConstr :: TableCellAlignment -> Constr #

dataTypeOf :: TableCellAlignment -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TableCellAlignment) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TableCellAlignment) #

gmapT :: (forall b. Data b => b -> b) -> TableCellAlignment -> TableCellAlignment #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TableCellAlignment -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TableCellAlignment -> r #

gmapQ :: (forall d. Data d => d -> u) -> TableCellAlignment -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> TableCellAlignment -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TableCellAlignment -> m TableCellAlignment #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TableCellAlignment -> m TableCellAlignment #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TableCellAlignment -> m TableCellAlignment #

Generic TableCellAlignment Source # 
Instance details

Defined in CMarkGFM

Associated Types

type Rep TableCellAlignment :: Type -> Type #

Read TableCellAlignment Source # 
Instance details

Defined in CMarkGFM

Show TableCellAlignment Source # 
Instance details

Defined in CMarkGFM

Eq TableCellAlignment Source # 
Instance details

Defined in CMarkGFM

Ord TableCellAlignment Source # 
Instance details

Defined in CMarkGFM

type Rep TableCellAlignment Source # 
Instance details

Defined in CMarkGFM

type Rep TableCellAlignment = D1 ('MetaData "TableCellAlignment" "CMarkGFM" "cmark-gfm-0.2.6-G3rZtSwpqpk8LVz00lSWZb" 'False) ((C1 ('MetaCons "NoAlignment" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LeftAligned" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CenterAligned" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "RightAligned" 'PrefixI 'False) (U1 :: Type -> Type)))