Language.PureScript.Docs.AsHtml

Description

Synopsis

• 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 :: (InPackage ModuleName -> Maybe HtmlRenderContext) -> Package a -> HtmlOutput Html
• moduleAsHtml :: (InPackage ModuleName -> Maybe HtmlRenderContext) -> Module -> (ModuleName, HtmlOutputModule Html)
• makeFragment :: Namespace -> Text -> Text
• renderMarkdown :: Text -> Html

Documentation