dreadnip/jug

There is no license information available for the latest version (0.4.0) of this package.

Turn Twig templates into a static site.

0.4.0 2023-12-29 19:43 UTC

Requires

• php: ^8.2
• ext-dom: *
• ext-libxml: *
• ext-pdo: *
• erusev/parsedown-extra: ^0.8.1
• symfony/console: ^6.0 || ^7.0
• symfony/dom-crawler: ^6.0
• symfony/event-dispatcher: ^6.4
• symfony/filesystem: ^6.0 || ^7.0
• symfony/finder: ^6.0
• symfony/process: ^6.0
• symfony/translation: ^6.0
• symfony/twig-bridge: ^6.0
• symfony/yaml: ^6.0
• twig/twig: ^3.3

Requires (Dev)

• phpstan/phpstan: 1.8
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.6
• symfony/var-dumper: ^6.0

Unknown License

README

Jug is a minimal static site generator built on Symfony components. It does exactly one thing: turn twig templates into straight HTML.

Jug aims to be fast & flexible. You won't find an extensive plugin system, but rather a set of basic yet powerful tools that you can use to build exactly what you need.

Features

• Twig-powered
• Multilang ready (uses symfony/translations)
• Optimized images
• Watch & serve command for quick development
• Easy, PHP based config
• Events to customize the build before & after
• Smooth integration with Github Pages

Getting started

# Create a new project directory
mkdir my-project && cd my-project

# Install the package using composer
composer require dreadnip/jug

# Run the init command to generate your base site
./vendor/bin/jug init

# Run the serve command to view your site
./vendor/bin/jug serve

What's next

Take a look at the docs for more information.