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
BASEMETADATA
API/@functional-examples/devkit/BaseMetadata

BaseMetadata

interface
interface BaseMetadata

Base metadata that all examples should have.
Used for type constraints when users want stricter typing.

PROPERTIES

NAMETYPEDESCRIPTION
description?stringDescription of what the example demonstrates
idstringUnique identifier for the example
titlestringHuman-readable title