build: 🔧 add files to auto-build website #4
Conversation
.github/workflows/build-website.yml
Outdated
There was a problem hiding this comment.
This file is what auto-builds the website and puts it online. You don't need to touch it or change it at all.
| chapters: | ||
| - index.qmd | ||
| - part: "Preamble" | ||
| - part: "Sessions" | ||
| chapters: | ||
| - sessions/welcome.qmd | ||
| - sessions/motivation.qmd | ||
| - sessions/traditional-mediation-analysis.qmd | ||
| appendices: | ||
| - appendix/welcome.qmd |
There was a problem hiding this comment.
This section is where you add the files you want put onto the website. Unfortunately, you can't put slide files here. But we deal with that when you get to it.
I didn't put anything into part: "Preamble" because your precourse.qmd file was in one of the _files/ folders, which I moved in #2, so that needs to be merged first before you can add it correctly here.
| @@ -0,0 +1,140 @@ | |||
| # Motivation | |||
There was a problem hiding this comment.
Each "chapter" (or page on the website) must start with and only contain one # top level header. All other ones are ## or more.
|
@arborzhang the website is live at https://steno-aarhus.github.io/IDEG-mediation-course/ 🎉 |
…-course into build/add-quarto-website-build-files
|
@arborzhang I'll merge this in now, but please review my comments to get an understanding of what I've added and why :) |
@arborzhang I added several files to automatically build the website.
Whenever you use a new R package, you need to always run
usethis::use_package("PACKAGENAME")(where PACKAGENAME is the package you will use), so that the website builder knows how to install and use it. Just like how you do with the UKB RAP project.In general, it's good practice to name files all lower case (it looks nicer in the URL for the website) and to always start each "chapter" (session or any file you want as a page on the website) with a single
#header. You don't need to use the YAML header.Slides are a bit trickier. Let me know if or how you want to use them and I can help out with that.
In the
_quarto.ymlfile is a list of files you can add to put into the website. I'l make direct comments on them in the PR.