Package-level declarations
Types
Link copied to clipboard
class HtmlOnlyPostRenderer(context: Context, name: String = "index", relativePathToRoot: String) : PostRenderer
A subset of HtmlPostRenderer that generates only the HTML output resources without any additional resources.
Link copied to clipboard
class HtmlPostRenderer(val context: Context, resourcesLayout: InstallLayout.Html? = null, relativePathToRoot: String = ".", base: HtmlOnlyPostRenderer = HtmlOnlyPostRenderer(
context,
relativePathToRoot = relativePathToRoot,
), resourcesProvider: () -> Set<PostRendererResource> = {
setOfNotNull(
ThemePostRendererResource(
theme = context.documentInfo.theme.orDefault(DEFAULT_THEME),
locale = context.documentInfo.locale,
themeLayout = resourcesLayout?.themes,
),
ScriptPostRendererResource(scriptsLayout = resourcesLayout?.scripts),
MediaPostRendererResource(context.mediaStorage),
context.fileSystem.workingDirectory
?.let(::StaticAssetsPostRendererResource),
SitemapPostRendererResource(context),
SearchIndexGenerator
.takeIf { context.documentInfo.type == DocumentType.DOCS }
?.generate(context.sharedSubdocumentsData)
?.let(::SearchIndexPostRendererResource),
ThirdPartyPostRendererResource(context, librariesLayout = resourcesLayout?.libraries),
)
}) : PostRenderer
A PostRenderer that wraps content into a full HTML document. This includes all the features of HtmlOnlyPostRenderer, plus:
Link copied to clipboard
A PostRenderer for subdocuments, which generates a group (directory) containing a index.html resource, and a media directory if needed, and redirects scripts, themes, and other resources to the root's (HtmlPostRenderer) resources.