eicc/staticforge

Static site generator built in PHP with extensible feature system

1.5.1 2025-11-28 20:49 UTC

Requires

• php: ^8.3
• eicc/utils: ^1.0
• gajus/dindent: ^2.0
• league/commonmark: ^2.4
• phpseclib/phpseclib: ^3.0
• symfony/console: ^6.0
• symfony/yaml: ^6.0
• twig/twig: ^3.0
• vlucas/phpdotenv: ^5.5

Requires (Dev)

• mikey179/vfsstream: ^1.6
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^10.5
• shipmonk/dead-code-detector: ^0.13.5
• squizlabs/php_codesniffer: *

MIT

• Cal Evans

README

A PHP-based static site generator that processes content files through an event-driven pipeline to produce deployment-ready static websites.

Documentation

Full documentation is available at https://calevans.com/staticforge.

Installation

Install StaticForge using Composer:

composer require eicc/staticforge
vendor/bin/staticforge-install-templates.php

The second command installs the default templates without overwriting any existing templates.

Development Installation

If you want to contribute to StaticForge development:

git clone https://github.com/calevans/staticforge.git my-site
cd my-site
composer install
cp .env.example .env

Quick Start

Your StaticForge installation comes ready to use! Here's how to get started:

1. Edit your site configuration: Open .env and customize your site name, tagline, and other settings.

2. Optional: Create siteconfig.yaml: For static menus and site-wide settings.

3. Generate your site:

   php bin/console.php render:site

4. View your site: Open output/index.html in your browser.

5. Add more content: Create .md or .html files in the content/ directory and regenerate.

Development

Using Lando (Recommended)

# Start development environment
lando start

# Run tests
lando phpunit

# Check code style
lando phpcs src/

# Fix code style
lando phpcbf

# Run CLI commands
lando php bin/console.php list

Requirements

• PHP 8.4+
• Twig templating engine
• Composer for dependency management

License

See LICENSE file for details.