-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmarkdown
65 lines (49 loc) · 2.58 KB
/
README.Rmarkdown
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
---
output: github_document
---
# coursedown <img src="content/home/coursedown.png" align="right" width="220"/>
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```
<!-- badges: start -->
[![Netlify Status](https://api.netlify.com/api/v1/badges/ad93845a-da16-4591-bbf4-f1e2a2ccc019/deploy-status)](https://app.netlify.com/sites/coursedown/deploys)
<!-- badges: end -->
## Introducing coursedown
Build your R-based course websites with this IHEID themed course website template
and `{blogdown}`! Thought as a companion to the excellent
[`{iheiddown}`](https://github.com/jhollway/iheiddown) package,
`{coursedown}` cuts down the time you'll need to publish a fully functional
course website to share R code with your students to an hour or two!
## Getting started
Getting started with `{coursedown}` is as simple as hitting the
"Use this template" button above and creating your own repository. The only
thing left to do then is to head over to [Netlify](https://www.netlify.com/)
to deploy your site. This will take no more than **15 minutes**! For
an illustrated walk-through, head over to the website to find a
detailed [user guide](https://coursedown.netlify.app/courses/userguide/) and
check out the various possibilities the theme offers!
### Dependencies:
While the template itself does not depend on the following packages. Some of
the scripts depend on packages. You can either delete the problematic lab
scripts in the `static/labs` folder or install them before building your site by
running the following commands:
```{r, eval = FALSE}
install.packages("tidyverse")
install.packages("gapminder")
```
## Open an issue
Bug reports and suggestions for improvements are welcome! Simply [create an
issue](https://github.com/BBieri/coursedown/issues) on GitHub or [open up a
PR](https://github.com/BBieri/coursedown/compare).
## Acknowledgements:
The template was inspired by two other excellent blogdown sites:
[Alison Hill's "Sharing on short notice"](https://rstudio-education.github.io/sharing-short-notice/#1) and
[Andrew Heiss' Program Evaluation course](https://evalsp21.classes.andrewheiss.com/) and the present
version of the demo site contains "lab pages" from Alison Hill's site. These are only included for showcasing
the possibilities of the site and will be replaced over the coming weeks.
I cannot recommend [Alison Hill's](https://www.apreshill.com/) and [Andrew Heiss'](https://www.andrewheiss.com/) blogs enough if you want to learn more about
scientific publishing on the web in general or running a course on the web. Their
blogs taught me most of what I know today!