https://github.com/getpop/static-site-generator
[READ ONLY] Create a static version of the site
https://github.com/getpop/static-site-generator
pop site-builder ssg static-site-generator website
Last synced: 4 months ago
JSON representation
[READ ONLY] Create a static version of the site
- Host: GitHub
- URL: https://github.com/getpop/static-site-generator
- Owner: getpop
- License: gpl-2.0
- Created: 2019-08-19T05:31:24.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-07T09:27:43.000Z (about 2 years ago)
- Last Synced: 2025-01-08T17:32:06.822Z (9 months ago)
- Topics: pop, site-builder, ssg, static-site-generator, website
- Language: PHP
- Size: 133 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Static Site Generator
Create a static version of the site
## Install
Via Composer
``` bash
composer require getpop/static-site-generator
```
## Development
The source code is hosted on the [GatoGraphQL monorepo](https://github.com/GatoGraphQL/GatoGraphQL), under [`SiteBuilder/packages/static-site-generator`](https://github.com/GatoGraphQL/GatoGraphQL/tree/master/layers/SiteBuilder/packages/static-site-generator).
## Usage
Initialize the component:
``` php
\PoP\Root\App::stockAndInitializeModuleClasses([([
\PoP\SSG\Module::class,
]);
```
## PHP versions
Requirements:
- PHP 8.1+ for development
- PHP 7.2+ for production
### Supported PHP features
Check the list of [Supported PHP features in `GatoGraphQL/GatoGraphQL`](https://github.com/GatoGraphQL/GatoGraphQL/blob/master/docs/supported-php-features.md)
### Preview downgrade to PHP 7.2
Via [Rector](https://github.com/rectorphp/rector) (dry-run mode):
```bash
composer preview-code-downgrade
```
## Standards
[PSR-1](https://www.php-fig.org/psr/psr-1), [PSR-4](https://www.php-fig.org/psr/psr-4) and [PSR-12](https://www.php-fig.org/psr/psr-12).
To check the coding standards via [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer), run:
``` bash
composer check-style
```
To automatically fix issues, run:
``` bash
composer fix-style
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
To execute [PHPUnit](https://phpunit.de/), run:
``` bash
composer test
```
## Static Analysis
To execute [PHPStan](https://github.com/phpstan/phpstan), run:
``` bash
composer analyse
```
## Report issues
To report a bug or request a new feature please do it on the [GatoGraphQL monorepo issue tracker](https://github.com/GatoGraphQL/GatoGraphQL/issues).
## Contributing
We welcome contributions for this package on the [GatoGraphQL monorepo](https://github.com/GatoGraphQL/GatoGraphQL) (where the source code for this package is hosted).
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email leo@getpop.org instead of using the issue tracker.
## Credits
- [Leonardo Losoviz][link-author]
- [All Contributors][link-contributors]
## License
GNU General Public License v2 (or later). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/getpop/static-site-generator.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-GPLv2-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/getpop/static-site-generator/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/getpop/static-site-generator.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/getpop/static-site-generator.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/getpop/static-site-generator.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/getpop/static-site-generator
[link-travis]: https://travis-ci.org/getpop/static-site-generator
[link-scrutinizer]: https://scrutinizer-ci.com/g/getpop/static-site-generator/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/getpop/static-site-generator
[link-downloads]: https://packagist.org/packages/getpop/static-site-generator
[link-author]: https://github.com/leoloso
[link-contributors]: ../../../../../../contributors