Interface RendererHooks

Describes the hooks available to inject output in the default theme. If the available hooks don't let you put something where you'd like, please open an issue!

Properties

Applied immediately after the opening <body> tag.

Applied immediately before the closing </body> tag.

"comment.afterTags": [
    DefaultThemeRenderContext,
    Models.Comment,
    Models.Reflection,
]

Applied immediately after a comment's tags are rendered.

This may be used to set Models.CommentTag.skipRendering on any tags which should not be rendered as this hook is called before the tags are actually rendered.

"comment.beforeTags": [
    DefaultThemeRenderContext,
    Models.Comment,
    Models.Reflection,
]

Applied immediately before a comment's tags are rendered.

This may be used to set Models.CommentTag.skipRendering on any tags which should not be rendered.

"content.begin": [DefaultThemeRenderContext]

Applied immediately before the main template.

"content.end": [DefaultThemeRenderContext]

Applied immediately after the main template.

"footer.begin": [DefaultThemeRenderContext]

Applied immediately before the "Generated by TypeDoc" link in the footer.

Applied immediately after the "Generated by TypeDoc" link in the footer.

Applied immediately after the opening <head> tag.

Applied immediately before the closing </head> tag.

"pageSidebar.begin": [DefaultThemeRenderContext]

Applied immediately before calling context.pageSidebar.

"pageSidebar.end": [DefaultThemeRenderContext]

Applied immediately after calling context.pageSidebar.

"sidebar.begin": [DefaultThemeRenderContext]

Applied immediately before calling context.sidebar.

"sidebar.end": [DefaultThemeRenderContext]

Applied immediately after calling context.sidebar.