Safe Haskell | None |
---|---|
Language | Haskell2010 |
Yesod.Markdown
Synopsis
- newtype Markdown = Markdown {
- unMarkdown :: Text
- markdownToHtml :: Markdown -> Either PandocError Html
- markdownToHtmlTrusted :: Markdown -> Either PandocError Html
- markdownToHtmlWithExtensions :: Extensions -> Markdown -> Either PandocError Html
- markdownToHtmlWith :: ReaderOptions -> WriterOptions -> Markdown -> Either PandocError Html
- markdownFromFile :: FilePath -> IO Markdown
- parseMarkdown :: ReaderOptions -> Markdown -> Either PandocError Pandoc
- writePandoc :: WriterOptions -> Pandoc -> Either PandocError Html
- writePandocTrusted :: WriterOptions -> Pandoc -> Either PandocError Html
- yesodDefaultWriterOptions :: WriterOptions
- yesodDefaultReaderOptions :: ReaderOptions
- yesodDefaultExtensions :: [Extension]
- markdownField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Markdown
Documentation
Constructors
Markdown | |
Fields
|
Instances
Eq Markdown Source # | |
Ord Markdown Source # | |
Defined in Yesod.Markdown | |
Read Markdown Source # | |
Show Markdown Source # | |
IsString Markdown Source # | |
Defined in Yesod.Markdown Methods fromString :: String -> Markdown # | |
Semigroup Markdown Source # | |
Monoid Markdown Source # | |
ToMarkup Markdown Source # | |
Defined in Yesod.Markdown | |
PersistFieldSql Markdown Source # | |
PersistField Markdown Source # | |
Defined in Yesod.Markdown Methods toPersistValue :: Markdown -> PersistValue # |
Wrappers
markdownToHtml :: Markdown -> Either PandocError Html Source #
Process Markdown using our options and sanitization
markdownToHtmlTrusted :: Markdown -> Either PandocError Html Source #
No HTML sanitization
- *NOTE**: Use only with fully-trusted input.
markdownToHtmlWithExtensions :: Extensions -> Markdown -> Either PandocError Html Source #
Process markdown with given extensions
Uses our options, and overrides extensions only.
markdownToHtmlWithExtensions githubMarkdownExtensions
markdownToHtmlWith :: ReaderOptions -> WriterOptions -> Markdown -> Either PandocError Html Source #
Fully controllable Markdown processing
markdownFromFile :: FilePath -> IO Markdown Source #
Returns the empty string if the file does not exist
Conversions
parseMarkdown :: ReaderOptions -> Markdown -> Either PandocError Pandoc Source #
Deprecated: Don't use this directly
writePandoc :: WriterOptions -> Pandoc -> Either PandocError Html Source #
Deprecated: Don't use this directly
writePandocTrusted :: WriterOptions -> Pandoc -> Either PandocError Html Source #
Deprecated: Don't use this directly
Option sets
yesodDefaultWriterOptions :: WriterOptions Source #
Defaults minus WrapText, plus our extensions
yesodDefaultReaderOptions :: ReaderOptions Source #
Defaults plus our extensions, see yesodDefaultExtensions
yesodDefaultExtensions :: [Extension] Source #
raw_html
and auto_identifiers
Form helper
markdownField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Markdown Source #