From 2be6b3f37600b94f778f21cd63bc06fc3bcc67b3 Mon Sep 17 00:00:00 2001 From: carriewright11 Date: Fri, 6 Sep 2024 14:09:53 -0400 Subject: [PATCH] simplifying the home page based on principles learned from the marketing consultant --- index.Rmd | 72 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 43 insertions(+), 29 deletions(-) diff --git a/index.Rmd b/index.Rmd index da52d0c..67dbac7 100644 --- a/index.Rmd +++ b/index.Rmd @@ -1,5 +1,5 @@ --- -title: OTTR - GitHub sites and courses for busy people +title: OTTR - Website and Online Course Tools output: html_document: includes: @@ -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") -``` -
+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/)
+(*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: + +

+ -```{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!
-## 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). +
+ Click here for the BibTeX formatted citation ``` @article{ottr, author = {Candace Savonen, Carrie Wright, Ava M. Hoffman, John Muschelli, Katherine Cox, Frederick J. Tan and Jeffrey T. Leek}, @@ -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} } ``` +
+ +
+ +
+ + + +
+ +