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

LlmsTxtPostRendererResource

class LlmsTxtPostRendererResource(context: Context) : SubdocumentMapperPostRendererResource

A PostRendererResource that generates an llms.txt at the site root: a curated, agent-friendly index of every page in the site as absolute links to their Markdown counterparts.

The generated file follows the llmstxt.org convention:

an H1 with the document title,
a blockquote with the description supplied by .llmstxt,
a ## Docs section listing the root document and every subdocument as a Markdown link (if available, HTML otherwise).

Requires:

com.quarkdown.core.context.options.HtmlOptions.llmsTxtContent to be set via .llmstxt.
com.quarkdown.core.context.options.HtmlOptions.baseUrl to be set via .htmloptions.

Parameters

context

the context of the document being rendered

Constructors

LlmsTxtPostRendererResource

constructor(context: Context)

Properties

runsInPreviewMode

open override val runsInPreviewMode: Boolean = false

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

Functions

includeTo

open override fun includeTo(resources: MutableSet<OutputResource>, rendered: CharSequence)

Collects resources and adds them to the output set.