Skip to content

Commit

Permalink
Clarify Jekyll instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
gilgongo authored Jul 10, 2024
1 parent 009b3ba commit 169809c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To edit an individual file, you can use the Github web interface or make a fork

### Viewing the website offline

You can view the website (this repo) offline on your own machine using [Jekyll](https://jekyllrb.com/). Please see the [instructions for doing this here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll?platform=mac). Note that Windows and macOS users will need to make their changes to the website files first, then make a pull request. Click on the "Checks" tab of the pull request, on the right click on "Artifacts" and download the zipped website file. Unzip it (twice), cd into the extracted folder and run jekyll as per the above linked instructions. If you are on Linux, you can make and view your changes offline before making a PR, but you must install po4a (clone our [assets repo](https://github.com/jamulussoftware/assets) and install the latest .deb from there) along with Jekyll. Then clone the website repo, create your branch and run `_po4a_tools/po4a-create-all-targets.sh` before running jekyll and viewing the site on `http://127.0.0.1:4000/`. Please ask in [Discussions](https://github.com/jamulussoftware/jamulus/discussions) for help with this if necessary.
You can view the website (this repo) offline on your own machine using [Jekyll](https://jekyllrb.com/). Please see the [instructions for doing this here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). Note that Windows and macOS users will need to make their changes to the website files first, then make a pull request. Click on the "Checks" tab of the pull request, on the right click on "Artifacts" and download the zipped website file. Unzip it (twice), cd into the extracted folder and run `jekyll serve`. If you are on Linux, you can make and view your changes offline before making a PR, but you must install po4a (clone our [assets repo](https://github.com/jamulussoftware/assets) and install the latest .deb from there) along with Jekyll. Then clone the website repo, create your branch and run `_po4a_tools/po4a-create-all-targets.sh` before running `bundle exec jekyll serve` and viewing the site on `http://127.0.0.1:4000/`. Please ask in [Discussions](https://github.com/jamulussoftware/jamulus/discussions) for help with this if necessary.

## Formatting and style

Expand Down

0 comments on commit 169809c

Please sign in to comment.