Code example validation and extraction plugin for Autodocs
npm install @opensyntaxhq/autodocs-plugin-examplesCode example validation and extraction plugin for Autodocs.
``bash`
npm install -D @opensyntaxhq/autodocs-plugin-examples
`ts
import { defineConfig } from '@opensyntaxhq/autodocs';
export default defineConfig({
plugins: [
{
name: '@opensyntaxhq/autodocs-plugin-examples',
options: {
validate: true,
outputDir: 'examples',
},
},
],
});
`
- validate (boolean, optional): type-check examples (default false).outputDir
- (string, optional): directory (relative to output) for extracted examples.
When outputDir is set, the plugin writes examples.json` plus individual example files.