Skip to content

Search titles, headings, and documentation content.

↑↓ navigate Enter open Esc close

    Browse documentation

    Generated output planning

    Generated requests join authored documents and static files in one output plan. Sklair freezes that plan after pre-build hooks finish, before compilation changes the output directory.

    Output paths must be clean relative paths. Absolute paths, drive or namespace colons, backslashes, traversal, null bytes, and trailing directory separators are rejected. Use forward slashes, regardless of the host operating system.

    Sklair normalises and sorts generated requests before compilation. Every final path has one owner: two generated documents cannot claim the same path, and a generated document cannot overwrite an authored document or copied static file. The collision fails before replacement of the previous successful output.

    documents.render({
      layout = "article",
      output = "docs/compiler/index.html",
      source = "project:articles/compiler.md",
      body = html,
    })
    

    The optional source value labels the document's origin in diagnostics and collision reports. A namespaced value such as project:articles/compiler.md is useful when the document came from that file. This label is cosmetic: it helps identify the input while debugging, but does not affect rendering or cause Sklair to read a file.