@plures/praxis

---

@plures/praxis / index / createStateDocsGenerator

Function: createStateDocsGenerator()

createStateDocsGenerator(config): StateDocsGenerator

Defined in: src/integrations/state-docs.ts:703

Create a State-Docs generator instance

Parameters

config

StateDocsConfig

Generator configuration including project title and output target directory

Returns

StateDocsGenerator

A new StateDocsGenerator instance

Example

import { createStateDocsGenerator } from '@plures/praxis/integrations/state-docs';

const generator = createStateDocsGenerator({
  projectTitle: 'My Project',
  target: './docs/api',
});

const docs = generator.generateFromSchema(mySchema);
for (const doc of docs) {
  await writeFile(doc.path, doc.content);
}