Skip to content

Commit

Permalink
Added usage for deploying on github.
Browse files Browse the repository at this point in the history
  • Loading branch information
WyvernIXTL committed Jun 27, 2024
1 parent 217fffa commit 4c421ec
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
venv
public
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,32 @@
</div>


## Deploy to GH Pages on Change

1. Follow the [guide](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-a-repository-for-your-site) for enabling gh pages for your account.
2. Set und Settings > Pages > GitHub Pages > Build and deployment Source to `GitHub Actions`.
3. Create a yaml file in `.github/workflows` folder (for example `webpage.yaml`) and put the following content into it:

```yaml
name: Webpage

on:
push:
branches:
- main
paths:
- "install.cfg"

jobs:
webpage:
runs-on: ubuntu-latest
name: Compile Webpage
steps:
- name: Compile Webpage
uses: instructions-d-installation/[email protected]
- name: Deploy Webpage
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
```

0 comments on commit 4c421ec

Please sign in to comment.