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
EXAMPLES/getting-started

Getting Started

Minimal setup walkthrough showing a configuration file, a single-file example with frontmatter, and scanning.

meta-yml5 FILESbeginnergetting-started

All Example Files

FILE EXPLORER
demo.sh
1#!/usr/bin/env bash
2set -euo pipefail
3
4npx functional-examples scan
5