stati/stati

Static site generator compatible with any jekyll site

0.5.8 2019-05-28 19:42 UTC

Requires

• php: ^7.1
• erusev/parsedown: ^1.6
• erusev/parsedown-extra: ^0.7.1
• jasonlewis/resource-watcher: ^1.2
• liquid/liquid: ^1.4
• ramsey/pygments: ^1.0
• stati/categories: ^0.1
• stati/feed: ^0.1.2
• stati/paginate: ^0.1
• stati/related: ^0.1
• stati/seo: ^0.1.2
• symfony/console: ^3.3
• symfony/event-dispatcher: ^3.3
• symfony/filesystem: ^3.3
• symfony/finder: ^3.3
• symfony/yaml: ^3.3

Requires (Dev)

• codeclimate/php-test-reporter: ^0.4.4
• doctrine/instantiator: ^1.0.2
• mikey179/vfsstream: ^1.6
• phpunit/phpunit: ^5.4
• satooshi/php-coveralls: ^1.0

Suggests

• ext-yaml: *
• stati/avatar: An avatar generator for Stati
• stati/feed: A feed generation plugin for Stati
• stati/profiler: A profiler plugin for stati
• stati/seo: An SEO tag generator for stati

MIT

• jfoucher

README

A static site generator in PHP that can work with any existing jekyll site and get the same results.

That is the end goal anyway.

Install

For install and usage documentation, please see the documentation

Status

• Works with the Jekyll Documentation site, and many Jekyll themes
• Generates all defined collections, including custom defined collections in _config.yml
• Paginates posts and saves paginated post to the correct places
• Plugin architecture based on Symfony events
• scss file conversion (you need scss to be in your $PATH)
• Code highlighting with pygments (you need pygments to be in your $PATH)

Downsides

• Not entirely completely compatible with jekyll, most notably with the lack of liquid filters (Work in progress)
• Slower than Jekyll on the first run, especially if you highlight your code with {% highlight %} blocks or have many scss/sass files.

Contributing

• Try Stati with your site and let me know what fails by opening an issue here.
• Create or port some plugins

Why that name?

Because static turns out to be a reserved word in PHP. Who would've thought ?