functional-examplesFUNCTIONAL-EXAMPLES
DOCSEXAMPLESAPI
⌘K
GitHubnpm
Guides
  • Getting Started
  • Why functional-examples
  • Core Concepts
  • Plugins
  • Configuration
  • Testing Examples
  • Use Cases
Plugins
  • JavaScript Plugin
  • YAML Manifest Plugin
  • Test Plugin
  • Documentation Plugin
Advanced
  • Custom Extractors
  • Plugin Authoring
  • Snapshot Testing
  • CI Integration
Examples
  • CI Integration
  • Custom Extractor
  • Devkit README Snippets
  • Documentation Plugin
  • Getting Started
  • Getting Started
  • JavaScript Plugin
  • JSON Configuration
  • Metadata Validation
  • Mixed Plugins
  • Multi-Plugin Configuration
  • Plugin Authoring
  • Region Markers
  • Snapshot Testing
  • Test Assertions Reference
  • Test Plugin Example
  • YAML Manifest Plugin
API
  • @functional-examples/devkit
  • @functional-examples/documentation
  • @functional-examples/javascript
  • @functional-examples/test
  • @functional-examples/yaml-manifest
  • functional-examples
  • rehype-typedoc
  • vike-plugin-typedoc
GitHubGitHubnpmNPM
Guides
  • Getting Started
  • Why functional-examples
  • Core Concepts
  • Plugins
  • Configuration
  • Testing Examples
  • Use Cases
Plugins
  • JavaScript Plugin
  • YAML Manifest Plugin
  • Test Plugin
  • Documentation Plugin
Advanced
  • Custom Extractors
  • Plugin Authoring
  • Snapshot Testing
  • CI Integration
Examples
  • CI Integration
  • Custom Extractor
  • Devkit README Snippets
  • Documentation Plugin
  • Getting Started
  • Getting Started
  • JavaScript Plugin
  • JSON Configuration
  • Metadata Validation
  • Mixed Plugins
  • Multi-Plugin Configuration
  • Plugin Authoring
  • Region Markers
  • Snapshot Testing
  • Test Assertions Reference
  • Test Plugin Example
  • YAML Manifest Plugin
API
  • @functional-examples/devkit
  • @functional-examples/documentation
  • @functional-examples/javascript
  • @functional-examples/test
  • @functional-examples/yaml-manifest
  • functional-examples
  • rehype-typedoc
  • vike-plugin-typedoc
GitHubGitHubnpmNPM
PLUGINSCHEMAS
API/@functional-examples/devkit/PluginSchemas

PluginSchemas

interface
interface PluginSchemas

Schema definitions for a plugin (JSON Schema format).
Used for IDE autocomplete and documentation generation.

PROPERTIES

NAMETYPEDESCRIPTION
metadata?stringJSON Schema for metadata this plugin produces or expects. Used for metadata.d.ts generation and documentation.
options?stringJSON Schema for plugin options (passed to createPlugin()). Used to generate config file schema for IDE autocomplete.