wdpr
    Preparing search index...

    Interface RenderOptions

    Full configuration for renderToHtml().

    Every field is optional; defaults produce safe, standalone HTML output suitable for a full wiki page.

    interface RenderOptions {
        baseUrl?: string;
        embedAllowlist?: EmbedAllowlistEntry[] | null;
        footnotes?: Element[][];
        htmlBlockSandbox?: string | null;
        page?: PageContext;
        resolvers?: RenderResolvers;
        settings?: WikitextSettings;
    }
    Index

    Properties

    baseUrl? embedAllowlist? footnotes? htmlBlockSandbox? page? resolvers? settings?

    Properties

    baseUrl?: string

    Base URL for resolving protocol-relative URLs (e.g. "//example.com/path").

    The scheme of this URL (http: or https:) is prepended to protocol-relative references. When omitted, HTTPS is assumed.

    "https://scp-wiki.wikidot.com"
    embedAllowlist?: EmbedAllowlistEntry[] | null

    Allowlist for [[embed]] content with host and optional path validation.

    • undefined: Uses default allowlist (YouTube, Vimeo, etc. with path restrictions)
    • EmbedAllowlistEntry[]: Custom allowlist with host patterns and optional path prefixes
    • []: Block all embeds
    • null: Allow any HTTPS iframe (Wikidot's 'anyiframe' behavior)
    footnotes?: Element[][]

    Pre-collected footnote element arrays from SyntaxTree.footnotes. Passed through so the renderer can emit footnote bodies in the [[footnoteblock]] section.

    htmlBlockSandbox?: string | null

    Sandbox attribute value for htmlBlock iframes.

    • undefined/null: No sandbox attribute (Wikidot compatible, scripts can run)
    • string: Use as sandbox attribute value (e.g., "allow-scripts allow-same-origin")

    Examples:

    • No sandbox (Wikidot compatible): htmlBlockSandbox: null
    • Block scripts: htmlBlockSandbox: "allow-same-origin"
    • Allow scripts: htmlBlockSandbox: "allow-scripts allow-same-origin"

    Optionalpage

    page?: PageContext

    Page context for resolving relative links, local file paths, etc.

    resolvers?: RenderResolvers

    Callbacks for resolving users, HTML-block URLs, etc.

    settings?: WikitextSettings

    Context-dependent feature flags. Defaults to page-mode settings when omitted.

    Settings

    Member Visibility

    On This Page

    Properties