quarkdown-html/com.quarkdown.rendering.html.post.resources

Package-level declarations

Types

class MediaPostRendererResource(mediaStorage: ReadOnlyMediaStorage) : PostRendererResource

A PostRendererResource that includes media (such as images) from the document's media storage into the output, in its own directory.

PostRendererResource

sealed interface PostRendererResource

Strategy that determines what OutputResources are exported as part of the HTML output.

ProxiedPostRendererResource

class ProxiedPostRendererResource(base: PostRenderer) : PostRendererResource

A PostRendererResource that delegates resource generation to another PostRenderer.

ScriptPostRendererResource

class ScriptPostRendererResource(scriptsLayout: InstallLayoutDirectory?) : PostRendererResource

A PostRendererResource that copies the pre-bundled Quarkdown runtime script directory (quarkdown.min.js + source map) next to the HTML output, enabling fully offline rendering.

SearchIndexPostRendererResource

class SearchIndexPostRendererResource(index: SearchIndex) : PostRendererResource

A PostRendererResource that outputs a search index as a JSON file.

SitemapPostRendererResource

class SitemapPostRendererResource(context: Context) : PostRendererResource

A PostRendererResource that generates a sitemap.xml listing the root document and every subdocument as a <url><loc> entry with absolute URLs.

StaticAssetsPostRendererResource

class StaticAssetsPostRendererResource(parentDirectory: File) : PostRendererResource

A PostRendererResource that copies the contents of a public/ directory, located at the project's root (parentDirectory), directly into the output root.

ThemePostRendererResource

class ThemePostRendererResource(theme: DocumentTheme, locale: Locale?, themeLayout: InstallLayout.Html.Themes?) : PostRendererResource

A PostRendererResource that bundles CSS theme components and their sibling assets (fonts, images) for styling the HTML output.

ThirdPartyPostRendererResource

class ThirdPartyPostRendererResource(context: Context, librariesLayout: InstallLayoutDirectory?) : PostRendererResource

A PostRendererResource that bundles required third-party libraries (scripts, styles, fonts) into the output, enabling fully offline HTML rendering.

Properties

HTML_LIBRARY_OUTPUT_PATH

const val HTML_LIBRARY_OUTPUT_PATH: String

HTML_SCRIPT_FILE_NAME

const val HTML_SCRIPT_FILE_NAME: String

Main Quarkdown runtime script file, bundled by the bundleTypeScript Gradle task.

HTML_SCRIPT_OUTPUT_PATH

const val HTML_SCRIPT_OUTPUT_PATH: String

Output directory name under which the Quarkdown runtime script is emitted. Shared between this resource and the HTML document builder that loads <path>/quarkdown.min.js, so the producer and the consumer cannot drift apart.