Skip to content

Commit

Permalink
Add instructions on how to deploy to Github pages locally
Browse files Browse the repository at this point in the history
  • Loading branch information
gastaldi committed Nov 12, 2020
1 parent d668935 commit cf7e206
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -8,6 +8,7 @@ _site
_bin
setup.sh
.project
.env

# Vim temp files
*.swp
Expand Down
13 changes: 12 additions & 1 deletion README.md
Expand Up @@ -32,9 +32,20 @@ These instructions will get you a copy of the Quarkus.io website up and running

> If you encounter any unexpected errors during the above, please refer to the [troubleshooting](https://jekyllrb.com/docs/troubleshooting/#configuration-problems) page or the [requirements](https://jekyllrb.com/docs/installation/#requirements) page, as you might be missing development headers or other prerequisites.

**For more regarding the use of Jekyll, please refer to the [Jekyll Step by Step Tutorial](https://jekyllrb.com/docs/step-by-step/01-setup/).**

### Deploying to Github Pages
The website deployment is automatically performed by GitHub Actions (when commits are pushed to the `develop` branch).
If for some reason you need to deploy from your local machine, follow these instructions:

1. Install the [act](https://github.com/nektos/act#installation) executable to run GitHub Actions locally
2. Create an `.env` file in your cloned repository with the following contents (Where *<GITHUB_TOKEN>* needs to be replaced with a token that allows you to push to the https://github.com/quarkusio/quarkusio.github.io repository):

JEKYLL_PAT=<GITHUB_TOKEN>

3. Run `act`


## Writing a blog

To write a blog:
Expand Down

0 comments on commit cf7e206

Please sign in to comment.