Deploy to GitHub Pages

GitHub Pages allows you to deploy your site to GitHub's free static site hosting service.

There's a few steps to complete:

  1. Install gh-pages using yarn add gh-pages or npm i gh-pages

  2. Add the following to gridsome.config.js:

  siteUrl: 'https://<your-github-username>.github.io',
  pathPrefix: '/<your-gridsome-repo-name>',
  1. Add the following scripts to your package.json:
  "predeploy": "npm run build",
  "deploy": "gh-pages -d dist"
  1. Run the command npm run deploy

  2. Go to GitHub's website and make sure your Repo's settings under "GitHub Pages" show the gh-pages branch under "Source".

Notes

GitHub Pages allows you to have a "GitHub user page" that acts as a profile/main page on <your-github-username>.github.io by having a repo named <your-github-username>.github.io.

  • If you are deploying to your GitHub user page (your main site on <username>.github.io)
    • Remove this line from gridsome.config.js:
      - pathPrefix: '/<your-gridsome-repo-name>',
    • Now when you run the npm run deploy command, your project will be built and the contents of the dist folder will be pushed to the gh-pages branch which is where your "Github user page" will deploy from.
    • This also allows you to keep track of your project on the master branch (or any branch you want) while gh-pages only contains your built files.
  • If you are using a custom URL such as www.yourname.com you will need to change gridsome.config.js to:
    siteUrl: 'https://www.yourname.com',
  • If you are using an apex domain for your GitHub user page (ie. https://yourname.com points to all of your GitHub Pages sites), and your Gridsome project is not your GitHub user page (not on the root https://yourname.com page, but a separate repo), then you will need to make sure pathPrefix matches your Gridsome project's repo name in gridsome.config.js:
    pathPrefix: '/<your-gridsome-repo-name>',

Edit this page on GitHub