Skip to content

Commit

Permalink
Fixed instructions in readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
WyvernIXTL committed Jun 27, 2024
1 parent 4c421ec commit 1dc85f5
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,23 @@
</div>


## Usage
```yaml
path:
description: Path to config file. Defaults to ./install.cfg
default: ./install.cfg
output:
description: Path to directory, where the html file is written to. Defaults to ./public directory.
default: ./public
version:
description: Version of web-installation-instruction to use. If not specified, uses the latest version.
```
## 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`.
2. Set und Settings > Pages > GitHub Pages > Build and deployment Source to `Deploy from a branch`.
3. Create a yaml file in `.github/workflows` folder (for example `webpage.yaml`) and put the following content into it:

```yaml
Expand All @@ -22,17 +35,25 @@ on:
- main
paths:
- "install.cfg"
workflow_dispatch:
permissions:
contents: write
jobs:
webpage:
runs-on: ubuntu-latest
name: Compile Webpage
steps:
- uses: actions/checkout@v4
- name: Compile Webpage
uses: instructions-d-installation/web-installation-instruction-action@0.1.0
uses: instructions-d-installation/web-installation-instruction-action@v0.1.0
- name: Deploy Webpage
uses: peaceiris/actions-gh-pages@v4
uses: JamesIves/github-pages-deploy-action@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
folder: ./public
```

4. Push it.
5. Go to actions and execute it at least once.
6. Check under Settings > Pages > GitHub Pages > Build and deployment if "Branch" is set to "gh-pages".

0 comments on commit 1dc85f5

Please sign in to comment.