Skip to content

staticweb-io/static-deploy

Repository files navigation

Static Deploy

Ask DeepWiki

A WordPress plugin for static site generation and deployment.

Static Deploy is a fork of Leon Stafford's WP2Static with many improvements. After development of WP2Static stalled for several years, we forked it and continue to maintain it.

Installation

Download a zip file from the releases page. and install it in your WordPress site.

Advanced: If you have Nix installed, you can build from source via nix build github:staticweb-io/static-deploy#plugin. This will create a zip file at result/static-deploy.zip which you can then install in your WordPress site.

Support

Please open an issue for new support questions.

Documentation

A DeepWiki is available.

Migrating from WP2Static

Install the plugin and run wp static-deploy import_wp2static_options --all. This will import all the core plugin options and the S3 addon options. You will still need to enable deployment addons and import options for any other deployment addons if you have them.

Development

Development requires installing Nix.

After checking out this repository and making changes, you can build the plugin with your changes by running nix build .#plugin. This will create a zip file at result/static-deploy.zip.

If you make changes to composer.json, or composer.lock, you will need to update the vendorHashes in flake.nix by running nix develop ./dev -c bin/update-hashes.

You can run the development environment via cd dev && nix run. This starts MySQL, PHP-FPM, and Nginx running WordPress with this plugin installed. The WordPress site is available at http://localhost:8888 with credentials "user" and "pass".

Testing

To run the tests, run nix flake check ./dev from within this repository.

Test results are available on the actions page.

About

A WordPress plugin for static site generation and deployment.

Resources

License

Stars

Watchers

Forks

Contributors 28