Skip to content

Commit

Permalink
Add note about deployment on pushes to main
Browse files Browse the repository at this point in the history
  • Loading branch information
alexnitta authored and joelnitta committed Dec 14, 2024
1 parent 04fcf19 commit 9b525d5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Created with [Quarto](https://quarto.org/) in [R](https://www.r-project.org/).

Production deployment is set up using GitHub Actions with [./.github/workflows/publish-cloudflare-pages.yml](./.github/workflows/publish-cloudflare-pages.yml).

On pushes to the `main` branch, this workflow will deploy the site to Cloudflare Pages.

The workflow file is very simple and basically runs two commands:

1. `Rscript -e 'babelquarto::render_website()'`, which compiles the Quarto blog to a static website within the `_site` folder. This folder contains an `index.html` which is the root of the website, as well as various JavaScript and CSS files and images; you can read more on [`babelquarto`](https://docs.ropensci.org/babelquarto/). Note that `_site` is ignored in `.gitignore` because it is generated from the source code; the source code is what we track in version control, not the built files.
Expand Down

0 comments on commit 9b525d5

Please sign in to comment.