https://github.com/spress/spress

PHP Static site generator
https://github.com/spress/spress

php spress static-site-generator twig

Last synced: about 1 month ago
JSON representation

PHP Static site generator

• Host: GitHub
• URL: https://github.com/spress/spress
• Owner: spress
• License: mit
• Created: 2013-09-29T18:01:42.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-09-29T20:57:25.000Z (about 1 year ago)
• Last Synced: 2024-11-10T08:39:57.219Z (about 1 month ago)
• Topics: php, spress, static-site-generator, twig
• Language: PHP
• Homepage: http://spress.yosymfony.com/
• Size: 1.79 MB
• Stars: 374
• Watchers: 28
• Forks: 26
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Spress - PHP Static site generator

=================================

[![Build Status](https://travis-ci.org/spress/spress.svg?branch=master)](https://travis-ci.org/spress/spress)

[![Build status](https://ci.appveyor.com/api/projects/status/mjsjdgauj7ks3ogn/branch/master?svg=true)](https://ci.appveyor.com/project/yosymfony/spress/branch/master)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/1ea79d8e-894d-4cf5-8f64-c941376b3f77/mini.png)](https://insight.sensiolabs.com/projects/1ea79d8e-894d-4cf5-8f64-c941376b3f77)

Spress is a static site generator built with Symfony components.

License: [MIT](https://github.com/spress/spress/blob/master/LICENSE).

Requirements

------------

* Linux, Unix, Mac OS X or Windows.

* PHP +7.4.

* [Composer](http://getcomposer.org/).

Community

---------

* Documentation: [spress.yosymfony.com](http://spress.yosymfony.com/docs/).

* Mention [@spress_cms](https://twitter.com/spress_cms) on Twitter.

Discuss and share your opinions in Gitter chat:

[![Gitter](https://badges.gitter.im/spress/Spress.svg)](https://gitter.im/spress/Spress?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

### Contributing

When Contributing code to Spress, you must follow its coding standards. Spress follows

[PSR-2 coding style](http://www.php-fig.org/psr/psr-2/).

Keep in mind the golden rule: **Imitate the existing Spress code**.

#### Pull Requests

* Fork the Spress repository.

* Create a new branch for each feature or improvement.

* New features: Send a pull request from each feature branch to master branch.

* Fixes: Send a pull request to 2.1 branch.

#### Unit testing

All pull requests must be accompanied by passing unit tests. Spress uses [phpunit](http://phpunit.de/) for testing.

How to make spress.phar

-----------------------

We are using [Box Project](https://github.com/humbug/box) for generating the `.phar` file.

```bash

$ cd spress

$ box build

```

Unit tests

----------

You can run the unit tests with the following command:

```bash

$ cd spress

$ composer test

```