GitHub Pages


  • FREE
  • Custom domain support



Official static web hosting guide

GitHub Pages Basics

Deploying to GitHub Pages with WP Static Site Generator

Manual deploy with the free version

  • select the ZIP deployment method within the plugin’s settings
  • set your Base URL to the final domain your users will visit your webite on
  • optionally set any other configuration options for the crawling, processing or deployment phases
  • generate your static site and download your resulting ZIP file
  • unzip the folder to a directory under git version control
  • git add .
  • git comit -m "new version of my static site"
  • git push

Use a GUI git tool instead of the command line method above if you prefer.

For easier deployments via the ZIP/test deploy method, consider linking the latest export directory the plugin generates (symlinked to latest-export in your Working Directory) to your GitHub repo. Then you don’t need to download anything off your WordPress server to commit and deploy!

Auto deploy with the Pro version

  • select the GitHub Pages deployment method within the plugin’s settings

GitHub Pages deployment option

If it’s your first time deploying to GitHub Pages, you’ll need to ensure you’re pushing to a repository/branch with at leat one commit. You can use the GitHub UI to quickly create a file in a branch.

GitHub Pages configuration options explained

Base URL

Set this to the final domain your users will visit your site on. If you’re just getting started you can set it to your GitHub Pages user/org’s URL, ie

Personal Access Token

You can find these within your GitHub account on the Personal access token page.

Account & Repository Name

Concatenate your GitHub user or organization name and your repository name, using a forward slash, ie leonstafford/wordpress-static-html-plugin.


This will usually be the master or gh-pages branch, depending on what type of repository you are pushing your site to. Which do I need?


In certain configurations, you may choose to keep your static files within the /docs subdirectory within your repository. In this case, simply enter docs here. In all other cases, you may leave this field empty.

Did you know, you don’t need to save any of your credentials within the plugin if you are exporting via the UI (vs CRON/CLI). Just enter your credentials on the settings page and hit Start static site export. If you navigate away from the page, your credentials will not persist. You can also hit the Reset to default settings button to clear any settings you’ve saved for the plugin from your WordPress database.

Comments powered by Talkyard.