A WordPress plugin to sync content with a GitHub repository (or Jekyll site)
Ever wish you could collaboratively author content for your WordPress site (or expose change history publicly and accept pull requests from your readers)?
Looking to tinker with Jekyll, but wish you could use WordPress’s best-of-breed web editing interface instead of Atom? (gasp!)
Well, now you can! Introducing WordPress GitHub Sync!
WordPress GitHub Sync does three things:
- Allows content publishers to version their content in GitHub, exposing “who made what change when” to readers
- Allows readers to submit proposed improvements to WordPress-served content via GitHub’s Pull Request model
- Allows non-technical writers to draft and edit a Jekyll site in WordPress’s best-of-breed editing interface
WordPress GitHub sync might be able to do some other cool things:
- Allow teams to collaboratively write and edit posts using GitHub (e.g., pull requests, issues, comments)
- Allow you to sync the content of two different WordPress installations via GitHub
- Allow you to stage and preview content before “deploying” to your production server
How it works
The sync action is based on two hooks:
- A per-post sync fired in response to WordPress’s
save_posthook which pushes content to GitHub - A sync of all changed files triggered by GitHub’s
pushwebhook (outbound API call)
Download & install the zip archive
The plugin package installer can be downloaded from the WP2E project tab called “code”.
1 – Select the version to download if this option is available otherwise the “latest” version of the main plugin will be used.
2 – After downloading the zip archive install the plugin package installer in you local environment and activate the script from the plugin list.
3 – Under the section “Plugins” of the admin dashboard you should see a new “Dependencies & Licenses” link. Follow the instructions from this panel to finalize the installation of the missing dependencies.
-
- Give a name to your project
-
- Download the Installer Package
-
- Install & activate the plugin locally
-
- Install the suggested dependencies
Tips: Use the WP2E panel to add/suggest new dependencies to the local installation. Press F5 in the list of dependencies if the changes are not displayed right away.