generated from jhudsl/OTTR_Template_Website
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.Rmd
87 lines (64 loc) · 2.95 KB
/
index.Rmd
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
---
title: <img src="./resources/images/basic_otter_water.PNG" width = 100px> OTTR - Website and Online Course Tools
output:
html_document:
includes:
in_header: GA_Script.Rhtml
---
<div class = "banner_color">
<br>
</div>
```{r, fig.align='center', fig.alt= "OTTR helps build github based websites with less hassle. Catch potential mistakes before they go live", echo = FALSE, out.width= "40%"}
knitr::include_graphics("./resources/images/why-ottr.png")
```
## What is OTTR:
OTTR is a set of tools and templates to help you make websites and online courses more easily!
It helps you use [GitHub](https://github.com/) to publish websites and courses for free.
## Benefits of OTTR:
- OTTR is free!
- No software installations needed
- Automatically preview content on GitHub before you publish (not just locally!)
- Automatically check spelling (and customize it!)
- Automatically and periodically check for broken links
- Easily customize branding
- Easily include code (and avoid version difference issues using Docker containers)
- Easily format courses for learning platforms like [coursera](https://www.coursera.org/) and [Leanpub](https://leanpub.com/)
- Easily update courses! (only edit once and it gets propagated to all locations)
<br>
(*Note that you will need to establish a publishing contract with coursera if you want to publish there)
Check out this short video about OTTR:
<p align="center"><iframe width="560" height="315" src="https://www.youtube.com/embed/oQ8d42fSn0o" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></p>
## How to use OTTR:
1. Edit and write websites and courses in [R Markdown files](https://rmarkdown.rstudio.com/) (or Quarto - coming soon!)
1. Use GitHub to host your content, we will walk you through how!
1. Let the GitHub actions in our tools do all the checks and rendering so you don't have too
1. Update your content as needed based on the errors OTTR finds and the preview
1. Publish your websites and courses!
<br>
## How to Cite OTTR:
Please cite our [OTTR manuscript here!](https://www.tandfonline.com/doi/full/10.1080/26939169.2022.2118646)📝👀
<details>
<summary>Click here for the BibTeX formatted citation</summary>
```
@article{ottr,
author = {Candace Savonen, Carrie Wright, Ava M. Hoffman, John Muschelli, Katherine Cox, Frederick J. Tan and Jeffrey T. Leek},
title = {Open-source Tools for Training Resources – OTTR},
journal = {Journal of Statistics and Data Science Education},
volume = {31},
number = {1},
pages = {57-65},
year = {2023},
publisher = {Taylor & Francis},
doi = {10.1080/26939169.2022.2118646},
URL = {https://doi.org/10.1080/26939169.2022.2118646},
eprint = {https://doi.org/10.1080/26939169.2022.2118646}
}
```
</details>
<br>
<center>
<a href="https://ottrproject.org/getting_started.html">
<img src="resources/images/getstarted.png" width = 30%>
</a>
</center>
<br>