Deploy Doks to GitHub Pages
Example repo showing how to publish your Doks site to GitHub Pages — automatically
- Add
.github/workflows/deploy-github.yml
:
# Deploy your Hyas site to GitHub Pages
name: GitHub Pages
on:
push:
branches:
- master
jobs:
deploy:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'npm'
- name: Install dependencies
run: npm install
- name: Check for linting errors
run: npm test
- name: Build production website
run: npm run build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
-
Click on the Actions tab of your GitHub repo and wait for the action to finish succesfully (after approximately 30 seconds).
-
Go to the Settings tab of your GitHub repo, and next to the Pages section. Select branche
gh-pages
and click Save. -
Copy the Your site is published at URL and paste it as
baseurl
in./config/production/config.toml
. -
Set
canonifyURLs = true
in./config/production/config.toml
. -
Push the changes to GitHub and wait for the action to finish succesfully (after approximately 30 seconds).
-
That's it. After a minute or so, you site is avaliable at the Your site is published at URL.
Now, after every push to the master branch, your site will be updated — automatically.