Skip to content

@kekkai/blueprint / emitHandbook

Function: emitHandbook()

emitHandbook(blueprint): string

Defined in: emit/docs/docs.ts:30

Compile a Blueprint into a human-readable Handbook (markdown). Pure and deterministic — the same blueprint always yields the same string, so Bootstrap can hash it to decide whether a rewrite is needed. Sections with no data are omitted.

Parameters

blueprint

Blueprint

Returns

string

Example

ts
import { writeFileSync } from 'node:fs';

writeFileSync('docs/architecture-handbook.md', emitHandbook(blueprint));