purescript-0.15.12: PureScript Programming Language Compiler
Safe HaskellSafe-Inferred
LanguageHaskell2010

Language.PureScript.Docs.AsHtml

Description

Functions for rendering generated documentation from PureScript code as HTML.

Synopsis

Documentation

data HtmlOutput a #

Constructors

HtmlOutput 

Instances

Instances details
Functor HtmlOutput # 
Instance details

Defined in Language.PureScript.Docs.AsHtml

Methods

fmap :: (a -> b) -> HtmlOutput a -> HtmlOutput b #

(<$) :: a -> HtmlOutput b -> HtmlOutput a #

Show a => Show (HtmlOutput a) # 
Instance details

Defined in Language.PureScript.Docs.AsHtml

Methods

showsPrec :: Int -> HtmlOutput a -> ShowS #

show :: HtmlOutput a -> String #

showList :: [HtmlOutput a] -> ShowS #

data HtmlOutputModule a #

Instances

Instances details
Functor HtmlOutputModule # 
Instance details

Defined in Language.PureScript.Docs.AsHtml

Methods

fmap :: (a -> b) -> HtmlOutputModule a -> HtmlOutputModule b #

(<$) :: a -> HtmlOutputModule b -> HtmlOutputModule a #

Show a => Show (HtmlOutputModule a) # 
Instance details

Defined in Language.PureScript.Docs.AsHtml

Methods

showsPrec :: Int -> HtmlOutputModule a -> ShowS #

show :: HtmlOutputModule a -> String #

showList :: [HtmlOutputModule a] -> ShowS #

nullRenderContext :: HtmlRenderContext #

An HtmlRenderContext for when you don't want to render any links.

renderMarkdown :: Text -> Html #

Render Markdown to HTML. Safe for untrusted input. Relative links are | removed.