diff --git a/.vscode/json.code-snippets b/.vscode/json.code-snippets index 1422df9..eb6a154 100644 --- a/.vscode/json.code-snippets +++ b/.vscode/json.code-snippets @@ -35,7 +35,7 @@ "body": [ "## :technologist: Exercise: ${0:Title}", "", - "> Time: ~${1:Minutes} minutes.", + "**Time: ~${1:Minutes} minutes.**", "", "${2:Text}", ], @@ -45,9 +45,9 @@ "scope": "quarto,markdown", "prefix": "discussion", "body": [ - "## :speech_balloon: Discussion activity: ~${0:Title}", + "## :speech_balloon: Discussion activity: ${0:Title}", "", - "**Time: ~${1:Minutes}**", + "**Time: ~${1:Minutes} minutes.**", "", "${2:Text}", ], @@ -57,13 +57,13 @@ "scope": "quarto,markdown", "prefix": "reading", "body": [ - "::: callout-note", - "## :book: Reading task: ~${0:Minutes}", + "## :book: Reading task: ~${0:Title}", "", - "${1:Text body}", + "**Time: ~${1:Minutes} minutes.**", + "", + "${2:Text}", "", "{{< text_snippet sticky_up >}}", - ":::", ], "description": "Insert reading task section." }, diff --git a/.vscode/settings.json b/.vscode/settings.json index 2455726..73a3b99 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -21,9 +21,9 @@ ], "conventional-branch.format": "{Type}/{Branch}", "files.insertFinalNewline": true, - "cSpell.enableFiletypes": [ - "quarto" - ], + "cSpell.enabledFileTypes": { + "quarto": true + }, "cSpell.language": "en,en-GB", "conventionalCommits.scopes": [ "preamble", diff --git a/_extensions/rostools/r3-theme/includes/reading-website-r.qmd b/_extensions/rostools/r3-theme/includes/reading-website-r.qmd new file mode 100644 index 0000000..c513b1f --- /dev/null +++ b/_extensions/rostools/r3-theme/includes/reading-website-r.qmd @@ -0,0 +1,19 @@ +We will explain this a bit during the workshop, but read this to start +learning how the website is structured and how to read certain things. +Specifically, there are a few "syntax" type formatting of the text in +this website to be aware of: + +- Folder names always end with a `/`, for example `data/` means the + data folder. +- File names always end with their file extension, for example `content.md` + means the file is a Markdown file. +- R variables are always shown as is. For instance, for the code + `x <- 10`, `x` is a variable because it was assigned with 10. +- Functions always end with `()`, for instance `mean()` or + `read_csv()`. +- Sometimes functions have their package name appended with `::` to + indicate to run the code from the specific package, since we likely + haven't loaded the package with `library()`. For instance, to + install packages from GitHub using the `{pak}` package we use + `pak::pkg_install("user/packagename")`. You'll learn about this more + later. diff --git a/_extensions/rostools/r3-theme/includes/reading-website.qmd b/_extensions/rostools/r3-theme/includes/reading-website.qmd new file mode 100644 index 0000000..5b175a0 --- /dev/null +++ b/_extensions/rostools/r3-theme/includes/reading-website.qmd @@ -0,0 +1,9 @@ +We will explain this a bit during the lessons, but read this to start +learning how the website is structured and how to read certain things. +Specifically, there are a few "syntax" type formatting of the text in +this website to be aware of: + +- Folder names always end with a `/`, for example `data/` means the + data folder. +- File names always end with their file extension, for example `content.md` + means the file is a Markdown file. diff --git a/_extensions/rostools/r3-theme/text-snippet.lua b/_extensions/rostools/r3-theme/text-snippet.lua index 23411d1..de6ef37 100644 --- a/_extensions/rostools/r3-theme/text-snippet.lua +++ b/_extensions/rostools/r3-theme/text-snippet.lua @@ -23,7 +23,7 @@ computer to indicate this to the instructor :womans_hat: :tophat: ]] local faq_text = [[ -Throughout the many times we've taught this course and others, we +Throughout the many times we've taught this and other workshops we get asked a lot of questions. We have a [Frequently Asked Questions](https://guides.rostools.org/faq) page for keeping track of some of these questions. Check out this page, maybe your question has @@ -55,7 +55,7 @@ a code chunk. The code below also includes the code from the exercises. ]] local discord_text = [[ -If you want to get help virtually or after the course, you can join the +If you want to get help virtually or after the workshop, you can join the [Discord channel](https://discord.gg/WKyTF5yXBJ) where you can ask questions in the `questions-or-advice` text channel. ]]