You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

github-pages.md 3.0KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. +++
  2. title = "GitHub Pages"
  3. weight = 30
  4. +++
  5. By default, GitHub Pages uses Jekyll (A ruby based static site generator),
  6. but you can use whatever you want provided you have an `index.html` file in the root of a branch called `gh-pages`.
  7. That branch name can also be manually changed in the settings of a repository.
  8. We can use any CI server to build and deploy our site. For example:
  9. * [Github Actions](https://github.com/shalzz/zola-deploy-action)
  10. * [Travis CI](#travis-ci)
  11. ## Travis CI
  12. We are going to use [TravisCI](https://travis-ci.org) to automatically publish the site. If you are not using Travis already,
  13. you will need to login with the GitHub OAuth and activate Travis for the repository.
  14. Don't forget to also check if your repository allows GitHub Pages in its settings.
  15. ## Ensure Travis can access your theme
  16. Depending on how you added your theme Travis may not exactly know how to access
  17. it. The best way to ensure it will have full access to the theme is to use git
  18. submodules. When doing this ensure you are using the `https` version of the URL.
  19. ```shell
  20. $ git submodule add {THEME_URL} themes/{THEME_NAME}
  21. ```
  22. ## Allowing Travis to push to GitHub
  23. Before pushing anything, Travis needs a Github private access key in order to make changes to your repository.
  24. If you're already logged in to your account, just click [here](https://github.com/settings/tokens) to go to your tokens page.
  25. Otherwise, navigate to `Settings > Developer Settings > Personal Access Tokens`.
  26. Generate a new token, and give it any description you'd like.
  27. Under the "Select Scopes" section, give it repo permissions. Click "Generate token" to finish up.
  28. Your token will now be visible!
  29. Copy it into your clipboard and head back to Travis.
  30. Once on Travis, click on your project, and navigate to "Settings". Scroll down to "Environment Variables" and input a name of `GH_TOKEN` with a value of your access token.
  31. Make sure "Display value in build log" is off, and then click add. Now Travis has access to your repository.
  32. ## Setting up Travis
  33. We're almost done. We just need some scripts in a .travis.yml file to tell Travis what to do.
  34. ```yaml
  35. language: minimal
  36. before_script:
  37. # Download and unzip the zola executable
  38. # Replace the version numbers in the URL by the version you want to use
  39. - curl -s -L https://github.com/getzola/zola/releases/download/v0.8.0/zola-v0.8.0-x86_64-unknown-linux-gnu.tar.gz | sudo tar xvzf - -C /usr/local/bin
  40. script:
  41. - zola build
  42. # If you are using a different folder than `public` for the output directory, you will
  43. # need to change the `zola` command and the `ghp-import` path
  44. after_success: |
  45. [ $TRAVIS_BRANCH = master ] &&
  46. [ $TRAVIS_PULL_REQUEST = false ] &&
  47. zola build &&
  48. sudo pip install ghp-import &&
  49. ghp-import -n public &&
  50. git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages
  51. ```
  52. If your site is using a custom domain, you will need to mention it in the `ghp-import` command: `ghp-import -c vaporsoft.net -n public`
  53. for example.
  54. Credits: this page is based on the article https://vaporsoft.net/publishing-gutenberg-to-github/