Skip to content

buildTechnicalDesignDocumentHtml

buildTechnicalDesignDocumentHtml(data, customTemplateSource?): string

Defined in: technicalDesignDocumentTemplate.ts:1376

Render a Confluence-storage-format technical design document from a Salesforce project’s scanned metadata, covering objects/data model, security model, groups/queues/permissions, solution inventory, and custom code inventory.

TechnicalDesignDocumentData

The scanned project metadata to render.

string

A user-supplied Handlebars template to render instead of the built-in one. Compiled against the same Handlebars instance as the built-in template, so it can also use the loud helper. See the README’s “Custom Templates” section for the data shape.

string

The rendered XHTML document.