Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplifying the home page #53

Merged
merged 2 commits into from
Sep 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 43 additions & 29 deletions index.Rmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: <img src="./resources/images/basic_otter_water.PNG" width = 100px> OTTR - GitHub sites and courses for busy people
title: <img src="./resources/images/basic_otter_water.PNG" width = 100px> OTTR - Website and Online Course Tools
output:
html_document:
includes:
Expand All @@ -14,46 +14,49 @@ output:
knitr::include_graphics("./resources/images/why-ottr.png")
```

- **No installing software needed** - OTTR completely runs through GitHub so you don't have to render things locally or install anything on your computer.
- **Previews before you publish** Before you publish your changes to your Github-based websites, take a look at the preview that OTTR automatically provides.
- **Automatic spell and url checks** Have [Github action robots](./getting_started.html) do your repetitive tasks like spell check and re-rendering.
- **Customizable branding** Follow our guides to [customize the style of your website or course](./customize-style.html) to show your own branding.
- **Avoid dependency hell** If you plan to include code examples in your website or course use [our Docker image](https://hub.docker.com/repository/docker/jhudsl/base_ottr) for consistency across authors as well as to help you struggling with installing various packages.
- **Customize your own Docker image** Follow our guides to [customize the docker image for course or website you're making](./customize-docker.html).
## What is OTTR:

```{r, fig.align='center', fig.alt= "OTTR runs url, spell checks and renders a preview upon each pull request so you can check it before you publish it", echo = FALSE, out.width= "100%"}
knitr::include_graphics("https://github.com/jhudsl/ottrproject.org/raw/main/resources/images/checks.png")
```
<br>
OTTR is a set of tools and templates to help you make websites and online courses more easily!

<center>
<a href="https://ottrproject.org/getting_started.html">
<img src="resources/images/getstarted.png" width = 30%>
</a>
</center>
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/)
<br>
(*Note that you will need to establish a publishing contract with coursera if you want to publish there)

## OTTR for courses

OTTR originally started as a way to publish full online courses. If this is your interest, OTTR can help you write one course but publish it in three places.
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>


```{r, fig.align='center', fig.alt= "OTTR provides tools for customized spell check, checks for broken urls, checks for formmating, and tools to convert and render files to be compatible across publishing platforms to allow you to publish on bookdown, Leanpub, and coursera more easily", echo = FALSE, out.width= "400"}
knitr::include_graphics("https://github.com/jhudsl/OTTR_Template/raw/main/resources/screenshots/OTTR_Robot_Image.png")
```

- Edit and write a course in [R Markdown files](https://rmarkdown.rstudio.com/) and have it published to multiple different platforms:
- [Bookdown](https://bookdown.org/)
- [Leanpub](https://leanpub.com/bookstore?type=course)
- [Coursera](https://www.coursera.org/)
- Use automagic conversion to ease the lift of prepping the material for different platforms.

## How to use OTTR:

1. Edit and write a 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
## How to Cite OTTR:

**[See the OTTR manuscript here!](https://www.tandfonline.com/doi/full/10.1080/26939169.2022.2118646)📝👀**
Please cite our [OTTR manuscript here!](https://www.tandfonline.com/doi/full/10.1080/26939169.2022.2118646)📝👀

Here's the BibTeX formatted citation for that [JSDSE manuscript](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},
Expand All @@ -69,3 +72,14 @@ Here's the BibTeX formatted citation for that [JSDSE manuscript](https://www.tan
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>
Loading