Summary

Exported Class

API Reference

Exported Class

Renderer

Implements: RendererFields

Properties

siteTitle: string

siteRoot: string

exportMode: "flat" | "directory"

modulePrefix: string?

sections: { SiteSection }?

leafSections: { SiteSection }

sectionsById: { [string]: SiteSection }

moduleSectionByName: { [string]: string }?

navigation: NavigationConfig?

modules: { [string]: modules.ModuleInfo }

articles: { ArticleRecord }

stylesPath: string

favicon: string?

head: { HeadTag }?

extraHead: string?

extraScripts: string?

announcement: string?

openGraph: PageMeta?

articleMetaGenerator: (((ctx: any) → PageMeta))?

apiMetaGenerator: (((ctx: any) → PageMeta))?

customFilters: { [string]: ((any, { [string]: any }) → any) }?

customGlobals: { [string]: any }?

versionName: string?

versionLabel: string?

folderMetaBySectionId: { [string]: SectionFolderMeta }?

assetResolver: (((article: Article.Article, url: string) → string))?

includeMobileSectionLinks: boolean

templates: { article: template.Template, api: template.Template, index: template.Template, notFound: template.Template? }

markdown: markdown.Markdown

hoverMarkdown: markdown.Markdown

currentMod: modules.ModuleInfo?

currentArticle: Article.Article?

Renderer.new

Renderer.new(siteTitle: string, stylesPath: string, templates: { article: string, api: string, index: string, notFound: string? }, options: { siteRoot: string?, exportMode: ("flat" | "directory")?, modulePrefix: string?, sections: { SiteSection }?, moduleSectionByName: { [string]: string }?, navigation: NavigationConfig?, favicon: string?, head: { HeadTag }?, extraHead: string?, extraScripts: string?, announcement: string?, openGraph: PageMeta?, articleMetaGenerator: (((ctx: any) → PageMeta))?, apiMetaGenerator: (((ctx: any) → PageMeta))?, customFilters: { [string]: ((any, { [string]: any }) → any) }?, customGlobals: { [string]: any }?, versionName: string?, versionLabel: string?, folderMetaBySectionId: { [string]: SectionFolderMeta }?, assetResolver: (((article: Article.Article, url: string) → string))?, templateReader: (((path: string) → string))? }?) → Renderer

Renderer:_resolveWikiLink

Renderer:_resolveWikiLink(rawLink: string, currentModule: modules.ModuleInfo?) → string

Renderer:_truncateDocForHover

Renderer:_truncateDocForHover(doc: string?) → string?

Renderer:_renderTypeHoverHtml

Renderer:_renderTypeHoverHtml(signatureText: string?) → string?

Renderer:_renderSymbolHoverHtml

Renderer:_renderSymbolHoverHtml(currentMod: modules.ModuleInfo?, signatureText: string?, docText: string?) → string?

Renderer:_findHoverSymbol

Renderer:_findHoverSymbol(currentMod: modules.ModuleInfo?, core: string) → { signature: string?, doc: string? }?

Renderer:_resolveWikiLinkInfo

Renderer:_resolveWikiLinkInfo(rawLink: string, currentModule: modules.ModuleInfo?) → any

Renderer:_resolveTypeLink

Renderer:_resolveTypeLink(typeName: string, currentModule: modules.ModuleInfo) → string?

Renderer:_GetPath

Renderer:_GetPath(item: modules.ModuleInfo | Article.Article | string) → string

Renderer:getPath

Renderer:getPath(item: (modules.ModuleInfo | Article.Article | string)?) → string

Renderer:getLink

Renderer:getLink(item: (modules.ModuleInfo | Article.Article | string)?) → string

Renderer:getPathForRoute

Renderer:getPathForRoute(routePath: string) → string

Renderer:registerArticle

Renderer:registerArticle(article: Article.Article, key: string, localName: string, sectionId: string) → ()

Renderer:registerModule

Renderer:registerModule(module: modules.ModuleInfo, sectionId: string?) → ()

Renderer:shouldRenderApiIndex

Renderer:shouldRenderApiIndex() → boolean

Renderer:getGeneratedSectionLandingPages

Renderer:getGeneratedSectionLandingPages() → { { sectionId: string, routePath: string } }

Renderer:renderPage

Renderer:renderPage(tmpl: template.Template, toc: TOC, params: { [string]: any }, pageName: string?, pageDisplayName: string?) → string

Renderer:renderModule

Renderer:renderModule(name: string) → string

Renderer:renderArticle

Renderer:renderArticle(name: string) → string

Renderer:renderIndex

Renderer:renderIndex() → string

Renderer:renderSectionLanding

Renderer:renderSectionLanding(sectionId: string) → string

Renderer:renderApiIndex

Renderer:renderApiIndex() → string

Renderer:render404

Renderer:render404() → string?

Renderer:getJSONPath

Renderer:getJSONPath(item: modules.ModuleInfo) → string

Renderer:getJSONLink

Renderer:getJSONLink(item: modules.ModuleInfo) → string

Renderer:generateSearchIndex

Generates a search index as a JSON string. Each entry has: title, path, kind ("article"|"module"|"function"|"type"|"class"), and a text snippet for matching.

Renderer:generateSearchIndex() → string

Renderer:generateSitemap

Generates a sitemap.xml string. Requires an absolute baseUrl.

Renderer:generateSitemap(baseUrl: string) → string