{"id":27944975,"url":"https://github.com/elementor/static-html-output","last_synced_at":"2025-05-07T12:55:30.095Z","repository":{"id":37586248,"uuid":"260261139","full_name":"elementor/static-html-output","owner":"elementor","description":"Static HTML Output Plugin for WordPress","archived":false,"fork":false,"pushed_at":"2023-04-19T21:15:06.000Z","size":20150,"stargazers_count":126,"open_issues_count":72,"forks_count":34,"subscribers_count":9,"default_branch":"develop","last_synced_at":"2025-05-07T12:55:18.413Z","etag":null,"topics":["strattic"],"latest_commit_sha":null,"homepage":"https://statichtmloutput.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elementor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-04-30T16:23:30.000Z","updated_at":"2025-02-16T13:28:57.000Z","dependencies_parsed_at":"2023-12-03T06:44:50.028Z","dependency_job_id":"198f5323-bf05-4dcd-9e93-8ef17f6a5618","html_url":"https://github.com/elementor/static-html-output","commit_stats":null,"previous_names":["wp2static/static-html-output"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Fstatic-html-output","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Fstatic-html-output/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Fstatic-html-output/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elementor%2Fstatic-html-output/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elementor","download_url":"https://codeload.github.com/elementor/static-html-output/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252882792,"owners_count":21819155,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["strattic"],"created_at":"2025-05-07T12:55:25.659Z","updated_at":"2025-05-07T12:55:30.090Z","avatar_url":"https://github.com/elementor.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Static HTML Output\n\n[![CircleCI](https://circleci.com/gh/leonstafford/static-html-output.svg?style=svg)](https://circleci.com/gh/leonstafford/static-html-output)\n[![Packagist](https://img.shields.io/packagist/v/leonstafford/static-html-output.svg?color=239922\u0026style=popout)](https://packagist.org/packages/leonstafford/static-html-output)\n[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-239922)](https://github.com/phpstan/phpstan)\n\nWordPress plugin to generate a static copy of your site and deploy to GitHub Pages, S3, Netlify, etc.  Increase security, pageload speed and hosting options. Connect WordPress into your CI/CD workflow.\n\n### Other WordPress SSGs I mantain\n\n - [WP2Static](https://github.com/WP2Static/wp2static)\n - [SimplerStatic](https://github.com/WP2Static/simplerstatic)\n\n - [Homepage](https://statichtmloutput.com)\n - [Documentation](https://statichtmloutput.com/docs/)\n - [Support Forum](https://www.staticword.press/c/wordpress-static-site-generators/static-html-output/7)\n\n## WP-CLI commands\n\n - `wp statichtmloutput COMMAND`\n\nWhere `COMMAND` can be any of:\n\n - `options`\n - `generate`\n - `deploy`\n - `deploy_cache`\n\nGet help for any command by appending `--help`\n\n## Hooks\n\n### Modify the initial list of URLs to crawl\n\n - `statichtmloutput_modify_initial_crawl_list`\n - Filter hook\n\n*signature*\n```php\napply_filters(\n    'statichtmloutput_modify_initial_crawl_list',\n    $url_queue\n);\n```\n\n*example usage*\n```php\nfunction add_additional_urls( $url_queue ) {\n    $additional_urls = [\n        'http://mydomain.com/custom_link_1/',\n        'http://mydomain.com/custom_link_2/',\n    ];\n\n    $url_queue = array_merge(\n        $url_queue,\n        $additional_urls\n    );\n\n    return $url_queue;\n}\n\nadd_filter( 'statichtmloutput_modify_initial_crawl_list', 'add_additional_urls' );\n```\n### Post-deployment hook\n\n - `statichtmloutput_post_deploy_trigger`\n - Action hook\n\n*signature*\n```php\ndo_action(\n  'statichtmloutput_post_deploy_trigger',\n  $archive\n);\n```\n\n*example usage*\n```php\nfunction printArchiveInfo( $archive ) {\n    error_log( print_r( $archive, true ) );\n}\n\nadd_filter( 'statichtmloutput_post_deploy_trigger', 'printArchiveInfo' );\n```\n\n*example response*\n```\nArchive Object\n(\n    [settings] =\u003e Array\n        (\n            [selected_deployment_option] =\u003e github\n            [baseUrl] =\u003e https://leonstafford.github.io/demo-site-wordpress-static-html-output/\n            [wp_site_url] =\u003e http://example.test/\n            [wp_site_path] =\u003e /srv/www/example.com/current/web/wp/\n            [wp_uploads_path] =\u003e /srv/www/example.com/current/web/app/uploads\n            [wp_uploads_url] =\u003e http://example.test/app/uploads\n            [wp_active_theme] =\u003e /wp/wp-content/themes/twentyseventeen\n            [wp_themes] =\u003e /srv/www/example.com/current/web/app/themes\n            [wp_uploads] =\u003e /srv/www/example.com/current/web/app/uploads\n            [wp_plugins] =\u003e /srv/www/example.com/current/web/app/plugins\n            [wp_content] =\u003e /srv/www/example.com/current/web/app\n            [wp_inc] =\u003e /wp-includes\n            [crawl_increment] =\u003e 1\n        )\n\n    [path] =\u003e /srv/www/example.com/current/web/app/uploads/wp-static-html-output-1547668758/\n    [name] =\u003e wp-static-html-output-1547668758\n    [crawl_list] =\u003e\n    [export_log] =\u003e\n)\n\n```\n\n## Contributing / development\n\nContributions are very much welcome! Please don't be intimidated to file an issue, create a Pull Request or email me (Leon) [me@ljs.dev](mailto:me@ljs.dev).\n\n### Developing\n\n - `git clone git@github.com:WP2Static/static-html-output.git`\n - `cd static-html-output`\n - `composer install`\n - `composer test`\n - `composer coverage` (optional coverage generation, requires [Xdebug](https://xdebug.org))\n\n### Building an install .zip file\n\n - `composer build INSTALLER_FILENAME`\n\nThis will create the installer and place in your `$HOME/Downloads` directory.\n\nOn Windows, you will need the `zip` utility available to build an installer. I recommend using Git Bash shell and then manually installing the zip utility as per [these instructions](https://stackoverflow.com/a/55749636/1668057)\n\n### Localisation / translations\n\nLocalisation within the plugin isn't supported. Rather, it's recommended to use a browser extension if you need help translating the UI or you can run our documentation pages through any translation service.\n\n## Support\n\nPlease [raise an issue](https://github.com/WP2Static/static-html-output/issues/new) here on GitHub or on the plugin's [support forum](https://forum.wp2static.com).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felementor%2Fstatic-html-output","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felementor%2Fstatic-html-output","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felementor%2Fstatic-html-output/lists"}