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

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.

Requires com.quarkdown.core.context.options.HtmlOptions.baseUrl to be set via .htmloptions; if absent, no sitemap is emitted. The sitemap is also skipped when the document has no subdocuments.

Parameters

context

the context of the document being rendered, used to access the base URL, subdocument graph, and output naming strategy

Constructors

Link copied to clipboard
constructor(context: Context)

Properties

Link copied to clipboard
open override val runsInPreviewMode: Boolean = false

Whether this resource should be included in the output during live preview.

Functions

Link copied to clipboard
open override fun includeTo(resources: MutableSet<OutputResource>, rendered: CharSequence)

Collects resources and adds them to the output set.