Skip to content

Commit

Permalink
Render site
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 6, 2024
1 parent 7aea739 commit 4b65d03
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 58 deletions.
6 changes: 6 additions & 0 deletions docs/config_automation.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,19 @@ spell-check: yes
style-code: yes
# Test build the docker image if any docker-relevant files have been changed
docker-test: no
# Should URLs be tested periodically?
url-check-periodically: yes

##### Renderings run upon merge to main branch #####
# Rendering each platform's content
render-bookdown: yes
render-leanpub: yes
render-coursera: no

## Automate the creation of Book.txt file? TRUE/FALSE?
## This is only relevant if render-leanpub is yes, otherwise it will be ignored
make-book-txt: TRUE

# What docker image should be used for rendering?
# The default is jhudsl/base_ottr:main
rendering-docker-image: 'jhudsl/base_ottr:main'
117 changes: 59 additions & 58 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@



<title> OTTR - GitHub sites and courses for busy people</title>
<title> OTTR - Website and Online Course Tools</title>

<script src="site_libs/header-attrs-2.27.1/header-attrs.js"></script>
<script src="site_libs/jquery-3.6.0/jquery-3.6.0.min.js"></script>
Expand Down Expand Up @@ -489,7 +489,7 @@


<h1 class="title toc-ignore"><img src="resources/images/basic_otter_water.PNG" width = 100px>
OTTR - GitHub sites and courses for busy people</h1>
OTTR - Website and Online Course Tools</h1>

</div>

Expand All @@ -498,66 +498,60 @@ <h1 class="title toc-ignore"><img src="resources/images/basic_otter_water.PNG" w
<p><br></p>
</div>
<p><img src="resources/images/why-ottr.png" alt="OTTR helps build github based websites with less hassle. Catch potential mistakes before they go live" width="40%" style="display: block; margin: auto;" /></p>
<div id="what-is-ottr" class="section level2">
<h2>What is OTTR:</h2>
<p>OTTR is a set of tools and templates to help you make websites and
online courses more easily!</p>
<p>It helps you use <a href="https://github.com/">GitHub</a> to publish
websites and courses for free.</p>
</div>
<div id="benefits-of-ottr" class="section level2">
<h2>Benefits of OTTR:</h2>
<ul>
<li><strong>No installing software needed</strong> - OTTR completely
runs through GitHub so you don’t have to render things locally or
install anything on your computer.</li>
<li><strong>Previews before you publish</strong> Before you publish your
changes to your Github-based websites, take a look at the preview that
OTTR automatically provides.</li>
<li><strong>Automatic spell and url checks</strong> Have <a
href="./getting_started.html">Github action robots</a> do your
repetitive tasks like spell check and re-rendering.</li>
<li><strong>Customizable branding</strong> Follow our guides to <a
href="./customize-style.html">customize the style of your website or
course</a> to show your own branding.</li>
<li><strong>Avoid dependency hell</strong> If you plan to include code
examples in your website or course use <a
href="https://hub.docker.com/repository/docker/jhudsl/base_ottr">our
Docker image</a> for consistency across authors as well as to help you
struggling with installing various packages.<br />
</li>
<li><strong>Customize your own Docker image</strong> Follow our guides
to <a href="./customize-docker.html">customize the docker image for
course or website you’re making</a>.</li>
</ul>
<p><img src="https://github.com/jhudsl/ottrproject.org/raw/main/resources/images/checks.png" alt="OTTR runs url, spell checks and renders a preview upon each pull request so you can check it before you publish it" width="100%" style="display: block; margin: auto;" />
<br></p>
<center>
<a href="https://ottrproject.org/getting_started.html">
<img src="resources/images/getstarted.png" width = 30%> </a>
</center>
<p><br></p>
<div id="ottr-for-courses" class="section level2">
<h2>OTTR for courses</h2>
<p>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.</p>
<p><img src="https://github.com/jhudsl/OTTR_Template/raw/main/resources/screenshots/OTTR_Robot_Image.png" 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" width="400" style="display: block; margin: auto;" /></p>
<ul>
<li>Edit and write a course in <a
href="https://rmarkdown.rstudio.com/">R Markdown files</a> and have it
published to multiple different platforms:
<ul>
<li><a href="https://bookdown.org/">Bookdown</a></li>
<li><a
href="https://leanpub.com/bookstore?type=course">Leanpub</a><br />
</li>
<li><a href="https://www.coursera.org/">Coursera</a><br />
</li>
</ul></li>
<li>Use automagic conversion to ease the lift of prepping the material
for different platforms. <br></li>
<li>OTTR is free!</li>
<li>No software installations needed</li>
<li>Automatically preview content on GitHub before you publish (not just
locally!)</li>
<li>Automatically check spelling (and customize it!)</li>
<li>Automatically and periodically check for broken links</li>
<li>Easily customize branding</li>
<li>Easily include code (and avoid version difference issues using
Docker containers)</li>
<li>Easily format courses for learning platforms like <a
href="https://www.coursera.org/">coursera</a> and <a
href="https://leanpub.com/">Leanpub</a> <br> (*Note that you will need
to establish a publishing contract with coursera if you want to publish
there)</li>
</ul>
<p>Check out this short video about OTTR:</p>
<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>
</div>
<div id="how-to-use-ottr" class="section level2">
<h2>How to use OTTR:</h2>
<ol style="list-style-type: decimal">
<li>Edit and write a websites and courses in <a
href="https://rmarkdown.rstudio.com/">R Markdown files</a> (or Quarto -
coming soon!)</li>
<li>Use GitHub to host your content, we will walk you through how!</li>
<li>Let the GitHub actions in our tools do all the checks and rendering
so you don’t have too</li>
<li>Update your content as needed based on the errors OTTR finds and the
preview</li>
<li>Publish your websites and courses! <br></li>
</ol>
</div>
<div id="how-to-cite-ottr" class="section level2">
<h2>How to Cite OTTR</h2>
<p><strong><a
href="https://www.tandfonline.com/doi/full/10.1080/26939169.2022.2118646">See
the OTTR manuscript here!</a>📝👀</strong></p>
<p>Here’s the BibTeX formatted citation for that <a
href="https://www.tandfonline.com/doi/full/10.1080/26939169.2022.2118646">JSDSE
manuscript</a>.</p>
<h2>How to Cite OTTR:</h2>
<p>Please cite our <a
href="https://www.tandfonline.com/doi/full/10.1080/26939169.2022.2118646">OTTR
manuscript here!</a>📝👀</p>
<details>
<summary>
Click here for the BibTeX formatted citation
</summary>
<pre><code>@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},
Expand All @@ -571,6 +565,13 @@ <h2>How to Cite OTTR</h2>
URL = {https://doi.org/10.1080/26939169.2022.2118646},
eprint = {https://doi.org/10.1080/26939169.2022.2118646}
}</code></pre>
</details>
<p><br></p>
<center>
<a href="https://ottrproject.org/getting_started.html">
<img src="resources/images/getstarted.png" width = 30%> </a>
</center>
<p><br></p>
</div>

<hr>
Expand Down

0 comments on commit 4b65d03

Please sign in to comment.