Safe Haskell | None |
---|---|
Language | Haskell2010 |
Language.PureScript.Docs.AsHtml
Description
Functions for rendering generated documentation from PureScript code as HTML.
- data HtmlOutput a = HtmlOutput {
- htmlIndex :: [(Maybe Char, a)]
- htmlModules :: [(ModuleName, HtmlOutputModule a)]
- data HtmlOutputModule a = HtmlOutputModule {
- htmlOutputModuleLocals :: a
- htmlOutputModuleReExports :: [(InPackage ModuleName, a)]
- data HtmlRenderContext = HtmlRenderContext {
- currentModuleName :: ModuleName
- buildDocLink :: Namespace -> Text -> ContainingModule -> Maybe DocLink
- renderDocLink :: DocLink -> Text
- renderSourceLink :: SourceSpan -> Maybe Text
- nullRenderContext :: ModuleName -> HtmlRenderContext
- declNamespace :: Declaration -> Namespace
- packageAsHtml :: (ModuleName -> HtmlRenderContext) -> Package a -> HtmlOutput Html
- moduleAsHtml :: HtmlRenderContext -> Module -> (ModuleName, HtmlOutputModule Html)
- makeFragment :: Namespace -> Text -> Text
- renderMarkdown :: Text -> Html
Documentation
data HtmlOutput a #
Constructors
HtmlOutput | |
Fields
|
Instances
Functor HtmlOutput # | |
Show a => Show (HtmlOutput a) # | |
data HtmlOutputModule a #
Constructors
HtmlOutputModule | |
Fields
|
Instances
Functor HtmlOutputModule # | |
Show a => Show (HtmlOutputModule a) # | |
data HtmlRenderContext #
Constructors
HtmlRenderContext | |
Fields
|
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.