Language.PureScript.Docs.AsHtml

Functions for rendering generated documentation from PureScript code as HTML.

Documentation

data HtmlOutput a

Constructors

HtmlOutput

Fields

• htmlIndex :: [(Maybe Char, a)]
• htmlModules :: [(ModuleName, HtmlOutputModule a)]

Instances

Functor HtmlOutput

Methods

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

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

Show a => Show (HtmlOutput a)

Methods

showsPrec :: Int -> HtmlOutput a -> ShowS

show :: HtmlOutput a -> String

showList :: [HtmlOutput a] -> ShowS

data HtmlOutputModule a

Constructors

HtmlOutputModule

Fields

• htmlOutputModuleLocals :: a
• htmlOutputModuleReExports :: [(InPackage ModuleName, a)]

Instances

Functor HtmlOutputModule

Methods

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

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

Show a => Show (HtmlOutputModule a)

Methods

showsPrec :: Int -> HtmlOutputModule a -> ShowS

show :: HtmlOutputModule a -> String

showList :: [HtmlOutputModule a] -> ShowS

data HtmlRenderContext

Constructors

HtmlRenderContext

Fields

• currentModuleName :: ModuleName
• buildDocLink :: Namespace -> Text -> ContainingModule -> Maybe DocLink
• renderDocLink :: DocLink -> Text
• renderSourceLink :: SourceSpan -> Text

nullRenderContext :: ModuleName -> HtmlRenderContext

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

declNamespace :: Declaration -> Namespace

packageAsHtml :: (ModuleName -> HtmlRenderContext) -> Package a -> HtmlOutput Html

moduleAsHtml :: HtmlRenderContext -> Module -> (ModuleName, HtmlOutputModule Html)

makeFragment :: Namespace -> Text -> Text

renderMarkdown :: Text -> Html

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