Yesod.Markdown

Documentation

newtype Markdown

Constructors

Markdown

Fields

• unMarkdown :: Text

Instances

Eq Markdown

Defined in Yesod.Markdown

Methods

(==) :: Markdown -> Markdown -> Bool

(/=) :: Markdown -> Markdown -> Bool

Ord Markdown

Defined in Yesod.Markdown

Methods

compare :: Markdown -> Markdown -> Ordering

(<) :: Markdown -> Markdown -> Bool

(<=) :: Markdown -> Markdown -> Bool

(>) :: Markdown -> Markdown -> Bool

(>=) :: Markdown -> Markdown -> Bool

max :: Markdown -> Markdown -> Markdown

min :: Markdown -> Markdown -> Markdown

Read Markdown

Defined in Yesod.Markdown

Methods

readsPrec :: Int -> ReadS Markdown

readList :: ReadS [Markdown]

readPrec :: ReadPrec Markdown

readListPrec :: ReadPrec [Markdown]

Show Markdown

Defined in Yesod.Markdown

Methods

showsPrec :: Int -> Markdown -> ShowS

show :: Markdown -> String

showList :: [Markdown] -> ShowS

IsString Markdown

Defined in Yesod.Markdown

Methods

fromString :: String -> Markdown

Semigroup Markdown

Defined in Yesod.Markdown

Methods

(<>) :: Markdown -> Markdown -> Markdown

sconcat :: NonEmpty Markdown -> Markdown

stimes :: Integral b => b -> Markdown -> Markdown

Monoid Markdown

Defined in Yesod.Markdown

Methods

mempty :: Markdown

mappend :: Markdown -> Markdown -> Markdown

mconcat :: [Markdown] -> Markdown

ToMarkup Markdown

Defined in Yesod.Markdown

Methods

toMarkup :: Markdown -> Markup

preEscapedToMarkup :: Markdown -> Markup

PersistFieldSql Markdown

Defined in Yesod.Markdown

Methods

sqlType :: Proxy Markdown -> SqlType

PersistField Markdown

Defined in Yesod.Markdown

Methods

toPersistValue :: Markdown -> PersistValue

fromPersistValue :: PersistValue -> Either Text Markdown

Wrappers

markdownToHtml :: Markdown -> Either PandocError Html

Process Markdown using our options and sanitization

markdownToHtmlTrusted :: Markdown -> Either PandocError Html

No HTML sanitization

• *NOTE**: Use only with fully-trusted input.

markdownToHtmlWithExtensions :: Extensions -> Markdown -> Either PandocError Html

Process markdown with given extensions

Uses our options, and overrides extensions only.

markdownToHtmlWithExtensions githubMarkdownExtensions

markdownToHtmlWith :: ReaderOptions -> WriterOptions -> Markdown -> Either PandocError Html

Fully controllable Markdown processing

markdownFromFile :: FilePath -> IO Markdown

Returns the empty string if the file does not exist

Conversions

parseMarkdown :: ReaderOptions -> Markdown -> Either PandocError Pandoc

Deprecated: Don't use this directly

writePandoc :: WriterOptions -> Pandoc -> Either PandocError Html

Deprecated: Don't use this directly

writePandocTrusted :: WriterOptions -> Pandoc -> Either PandocError Html

Deprecated: Don't use this directly

Option sets

yesodDefaultWriterOptions :: WriterOptions

Defaults minus WrapText, plus our extensions

yesodDefaultReaderOptions :: ReaderOptions

Defaults plus our extensions, see yesodDefaultExtensions

yesodDefaultExtensions :: [Extension]

raw_html and auto_identifiers

Form helper

markdownField :: Monad m => RenderMessage (HandlerSite m) FormMessage => Field m Markdown