README

StaticForge

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

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

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.

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

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

Configure your environment: Open .env to set infrastructure settings like SITE_BASE_URL (where your site lives) and UPLOAD_URL.
Configure site identity: Create siteconfig.yaml to define your site name, tagline, and menus.
```
site:
  name: "My Awesome Site"
  tagline: "Built with StaticForge"
```
Optional: Install additional templates:
```
composer require vendor/template-name
```
Optional: Create siteconfig.yaml: For static menus and site-wide settings.
Generate your site:
```
php bin/staticforge.php site:render
```
View your site: Open public/index.html in your browser.
Add more content: Create .md or .html files in the content/ directory and regenerate.

# Run tests
phpunit

# Check code style
phpcs src/

# Fix code style
phpcbf

# Run CLI commands
php bin/staticforge.php list

See LICENSE file for details.