functional-examplesFUNCTIONAL-EXAMPLES
API/@functional-examples/documentation/createGuideRenderer

createGuideRenderer

function
function createGuideRenderer(
  examples: ScannedExample<Record<string, unknown>>[],
  options: GuideRendererOptions
): GuideRenderer;

Create a guide renderer bound to a set of scanned examples.

Guide templates can reference any example by ID:

<%= example('basic-usage').file('scan.ts') %>

PARAMETERS

NAMETYPEDESCRIPTION
examplesScannedExample<Record<string, unknown>>[]—
optionsGuideRendererOptions—

RETURNS

GuideRenderer

EXAMPLES

import { createGuideRenderer } from '@functional-examples/documentation';
import { scan } from 'functional-examples';

const { examples } = await scan({ root: workspaceRoot });
const renderer = createGuideRenderer(examples);
const html = await renderer.renderFile('docs/guides/getting-started.md');