 |
VOOZH | about |
|
VOOZH | about |
This page provides a comprehensive reference for all features shipped with StaticForge. Features are modular, event-driven components that extend the core functionality of the static site generator. Each feature operates independently through the event system, enabling or disabling features without affecting the core build process.
For information about creating custom features, see Creating Custom Features. For the conceptual overview of the feature system architecture, see Feature System.
StaticForge discovers features from three locations with explicit priority ordering, allowing user-defined features to override library implementations.
Sources: src/Core/FeatureManager.php52-96 src/Core/FeatureManager.php146-231
| Priority Level | Location | Override Behavior |
|---|---|---|
| HIGHEST | src/Features/*/Feature.php | User features can disable library features |
| MEDIUM | vendor/**/composer.json extra.staticforge.feature | Third-party packages |
| LOWEST | vendor/eicc/staticforge/src/Features/*/Feature.php | Library defaults |
Features are identified by their getName() method return value. If a feature with the same name is loaded from a higher-priority location, the lower-priority version is skipped.
Sources: src/Core/FeatureManager.php52-85 src/Core/FeatureManager.php269-280
All features extend BaseFeature or BaseRendererFeature and implement FeatureInterface. Registration occurs during bootstrap before any content processing begins.
Example Registration: src/Features/MarkdownRenderer/Feature.php33-69
Features declare event listeners using the eventListeners array property:
The BaseFeature class automatically registers these listeners during register(), mapping event names to feature methods with priority values.
Sources: src/Features/MarkdownRenderer/Feature.php29-31 src/Features/MenuBuilder/Feature.php26-28
The following table catalogs all features shipped with StaticForge, organized by functional category.
| Feature Name | Events | Priority | File Types | Purpose |
|---|---|---|---|---|
| Content Renderers | ||||
MarkdownRenderer | RENDER | 100 | .md | Converts Markdown to HTML, applies templates |
HtmlRenderer | RENDER | 100 | .html | Processes HTML files, applies templates |
| Navigation & Structure | ||||
MenuBuilder | POST_GLOB | 100 | N/A | Generates navigation menus from frontmatter menu field |
Categories | POST_RENDER | 100 | N/A | Organizes content by category, modifies URLs |
CategoryIndex | POST_GLOB, PRE_RENDER, POST_RENDER, POST_LOOP | 50-150 | N/A | Generates category index pages with pagination |
ChapterNav | POST_RENDER | 100 | N/A | Creates previous/next navigation for sequential content |
Tags | POST_RENDER, POST_LOOP | 100 | N/A | Collects tags, generates tag cloud |
| SEO & Discovery | ||||
Sitemap | POST_RENDER, POST_LOOP | 100 | N/A | Generates sitemap.xml from all pages |
RssFeed | POST_RENDER, POST_LOOP | 100 | N/A | Generates RSS feeds per category |
RobotsTxt | POST_GLOB, POST_LOOP | 100-150 | N/A | Generates robots.txt honoring metadata |
| Interactive | ||||
Forms | RENDER | 50 | N/A | Processes form shortcodes with AJAX, spam protection |
Search | POST_RENDER, POST_LOOP | 100 | N/A | Builds client-side search index |
| Deployment & Optimization | ||||
CacheBuster | CREATE, RENDER | 100 | N/A | Generates unique build IDs for asset cache invalidation |
TemplateAssets | POST_LOOP | 100 | N/A | Copies template assets to output directory |
Upload | N/A | N/A | N/A | Uploads built site to SFTP or S3 |
Sources: src/Features/MarkdownRenderer/Feature.php22 src/Features/HtmlRenderer/Feature.php22 src/Features/MenuBuilder/Feature.php19 src/Features/CategoryIndex/Feature.php23 src/Features/RssFeed/Services/RssFeedService.php src/Features/RobotsTxt/Feature.php32 src/Features/Sitemap/Services/SitemapService.php
Features hook into specific stages of the generation pipeline through event subscriptions. The following diagram maps features to their primary event hooks.
Sources: src/Features/MarkdownRenderer/Feature.php29-31 src/Features/MenuBuilder/Feature.php26-28 src/Features/CategoryIndex/Feature.php33-39
Within each event, features execute in priority order (lower numbers first). Critical examples:
CategoryIndex (50) runs before MenuBuilder (100), ensuring category index pages exist before menu generationCategoryIndex (150) can defer category definition files before renderers process themForms (50) processes shortcodes before MarkdownRenderer and HtmlRenderer (100)Sources: src/Features/CategoryIndex/Feature.php33-39 src/Features/MenuBuilder/Feature.php26-28
Complex features delegate logic to service classes, keeping the main Feature.php focused on event handling and registration.
Example Service Delegation:
MarkdownRendererServiceMenuBuilderServiceSources: src/Features/MarkdownRenderer/Feature.php33-69 src/Features/MenuBuilder/Feature.php40-74 src/Features/CategoryIndex/Feature.php42-53
Features requiring configuration implement ConfigurableFeatureInterface, enabling validation via the audit:config command.
Example Implementation: src/Features/MenuBuilder/Feature.php30-38
Features without configuration requirements return empty arrays from both methods.
Sources: src/Features/MenuBuilder/Feature.php17-38
Features can be disabled via siteconfig.yaml using the disabled_features list:
The FeatureManager checks this list during discovery and skips registration for disabled features.
Sources: src/Core/FeatureManager.php59-63 src/Core/FeatureManager.php138-141 src/Core/FeatureManager.php210-214
Renderer features register file extensions they can process using ExtensionRegistry:
Only files with registered extensions are passed to the RENDER event, preventing unnecessary processing.
Sources: src/Features/MarkdownRenderer/Feature.php65-66 src/Features/HtmlRenderer/Feature.php56-57
Features store processed data in the Container under the features variable, making it available to templates:
Each feature is responsible for structuring its own data namespace under features[FeatureName].
Sources: src/Core/FeatureManager.php87-93
The following subsections provide in-depth documentation for each feature category:
Each subsection documents event handling specifics, configuration requirements, usage examples, and service architecture for the features in that category.
Refresh this wiki