search

jspsych / webbook

A web-based textbook for jsPsych
https://jspsych.github.io/webbook/
12 stars 3 forks source link

Consider a swap to something that can build via GH actions? #2

Open jodeleeuw opened 3 years ago

jodeleeuw commented 3 years ago

While I ❤️ R and {bookdown} I think it might be worth moving to a template + compiler that can just run directly in GH actions if many folks are going to be working on this project.

I've used Hugo for the ManyClasses website and it is directly editable on GitHub via markdown.

Open to other possibilities too.

jodeleeuw commented 3 years ago

Hugo themes that would work:

becky-gilbert commented 3 years ago

I also ❤️ R and bookdown but happy to switch if you want the GH editing & compiling features.

Hugo does look good. It says it supports different output formats but I couldn't find which ones exactly. One thing I like about bookdown is the ability to generate PDF and e-book formats as well as HTML.

jodeleeuw commented 3 years ago

I was able to setup a GH action that will run the bookdown compile routine and publish to GH pages. The only change this required was using renv for managing libraries in the project.

So I think we now have a good setup, where we can test locally in R and the deployment will be automatic on any pushes to main.