| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Rib.Parser.MMark
Description
Parsing Markdown using the mmark parser.
Synopsis
- parse :: FilePath -> Action MMark
- parsePure :: FilePath -> Text -> Either Text MMark
- parseWith :: [Extension] -> FilePath -> Action MMark
- parsePureWith :: [Extension] -> FilePath -> Text -> Either Text MMark
- defaultExts :: [Extension]
- render :: Monad m => MMark -> HtmlT m ()
- getFirstImg :: MMark -> Maybe URI
- getFirstParagraphText :: MMark -> Maybe Text
- projectYaml :: MMark -> Maybe Value
- data MMark
Parsing
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
parseWith :: [Extension] -> FilePath -> Action MMark Source #
Like parse but takes a custom list of MMark extensions
Arguments
| :: [Extension] | |
| -> FilePath | Filepath corresponding to the text to be parsed (used only in parse errors) |
| -> Text | Text to be parsed |
| -> Either Text MMark |
Like parsePure but takes a custom list of MMark extensions
defaultExts :: [Extension] Source #
Rendering
Extracting information
getFirstParagraphText :: MMark -> Maybe Text Source #
Get the first paragraph text of a MMark document.
Useful to determine "preview" of your notes.
projectYaml :: MMark -> Maybe Value #
Extract contents of an optional YAML block that may have been parsed.