rib-0.6.0.0: Static site generator using Shake

Safe Haskell	None
Language	Haskell2010

Rib.Parser.MMark

Contents

Parsing
Rendering
Extracting information
Re-exports

Description

Parsing Markdown using the mmark parser.

Synopsis

parse :: SourceReader MMark
parsePure :: FilePath -> Text -> Either Text MMark
render :: MMark -> Html ()
getFirstImg :: MMark -> Maybe URI
projectYaml :: MMark -> Maybe Value
data MMark

Parsing

parse :: SourceReader MMark Source #

SourceReader for parsing Markdown using mmark

parsePure Source #

Arguments

:: FilePath	Filepath corresponding to the text to be parsed (used only in parse errors)
-> Text	Text to be parsed
-> Either Text MMark

Pure version of parse

Rendering

render :: MMark -> Html () Source #

Render a MMark document as HTML

Extracting information

getFirstImg :: MMark -> Maybe URI Source #

Get the first image in the document if one exists

projectYaml :: MMark -> Maybe Value #

Extract contents of an optional YAML block that may have been parsed.

Re-exports

data MMark #

Representation of complete markdown document. You can't look inside of MMark on purpose. The only way to influence an MMark document you obtain as a result of parsing is via the extension mechanism.

Instances

Show MMark	Dummy instance. Since: mmark-0.0.5.0
Instance details Defined in Text.MMark.Type Methods showsPrec :: Int -> MMark -> ShowS # show :: MMark -> String # showList :: [MMark] -> ShowS #
NFData MMark
Instance details Defined in Text.MMark.Type Methods rnf :: MMark -> () #