sigwin/yassg

Yet Another Static Site Generator

1.0.0 2024-02-09 10:44 UTC

Requires

• php: ^8.2
• ext-zlib: *
• bentools/cartesian-product: ^1.4
• jsw/commonmark-figure-extension: ^1.1
• league/commonmark: ^2.3
• phpdocumentor/type-resolver: ^1.0
• phpstan/phpdoc-parser: ^1.0
• presta/sitemap-bundle: ^4.0
• spatie/commonmark-highlighter: ^3.0
• symfony/console: ^6.4 || ^7.0
• symfony/expression-language: ^6.4 || ^7.0
• symfony/filesystem: ^6.4 || ^7.0
• symfony/finder: ^6.4 || ^7.0
• symfony/form: ^6.4 || ^7.0
• symfony/framework-bundle: ^6.4 || ^7.0
• symfony/http-client: ^6.4 || ^7.0
• symfony/property-info: ^6.4 || ^7.0
• symfony/runtime: ^6.4 || ^7.0
• symfony/security-csrf: ^6.4 || ^7.0
• symfony/serializer: ^6.4 || ^7.0
• symfony/stopwatch: ^6.4 || ^7.0
• symfony/translation: ^6.4 || ^7.0
• symfony/twig-bundle: ^6.4 || ^7.0
• symfony/web-profiler-bundle: ^6.4 || ^7.0
• symfony/webpack-encore-bundle: ^2.0
• symfony/yaml: ^6.4 || ^7.0

Requires (Dev)

• phpunit/phpunit: ^11.0
• sigwin/infra: ~1.9.0

MIT

README

Start building a static site powered by Twig and Encore.

Use a YAML database to organize routes and data.

Get started

1. create an empty folder

   mkdir yassg-test && cd yassg-test

2. require the package

   composer require sigwin/yassg

3. init the project

   vendor/sigwin/yassg/bin/yassg yassg:init

4. run a dev server:

   make start/dev

Build the site

Pass the base URL to build

BASE_URL=https://example.com/subdir make build/clean

The output will be in the public/ folder, the contents of which needs to be deployed to the BASE_URL.

Pages CI setup

Includes Gitlab CI / Gitlab Pages setup.