search

jhudsl / OTTR_Template

OTTR for making courses! This is a template repo that helps people write 1 course but publish it in three places
https://www.ottrproject.org/
Creative Commons Attribution 4.0 International
15 stars 12 forks source link

Plan for Quarto #531

Open larnsce opened 2 years ago

larnsce commented 2 years ago

Is your feature request related to a problem? Please describe.

Thank you for this fantastic work. I discovered and read the pre-print with much excitement and am considering using the OTTR_Template for my next course. My feature request is not related to any problem, but rather a question about the direction that the OTTR_Template may take with regard to the newly developed Quarto publishing system.

Q1: Are you considering using Quarto books as another route for publishing?

Describe the solution you'd like

Another route for publishing that uses Quarto books in addition to bookdown.

Describe alternatives you've considered

Using the OTTR_Template to publish with bookdown, but then converting R Markdown files to Quarto documents. But, I am unsure how feasible that would be.

Additional context

Teaching novices with Quarto has opened a very promising route, as learners can stay within the Quarto publishing system for a range of output options (slides, books, websites), all of which required a learner to understand the usage of another R package. OTTR_Template would solve my gaps in competencies for docker, GitHub actions, and automation. Now I can't decide where to start first.

avahoffman commented 2 years ago

@larnsce we are very excited about quarto in general, but haven't discussed it much as a team yet. Thanks for raising this and for engaging with OTTR!

cansavvy commented 6 months ago

I think we should be able to add quarto compatibility for courses soon now that the quarto docker image is up and running.

Can use https://github.com/hadley/r4ds/ as our example for how to get that TOC to turn out.

cansavvy commented 5 months ago

Basically the idea here @howardbaek is that we need to make a version of this repository that looks more or less like the Bookdown website.

howardbaek commented 5 months ago

Here are links to various Quarto docs that may serve useful for solving this issue:

This is fairly new and raw, but may serve extremely useful:

howardbaek commented 5 months ago

The OTTR Template repo has a no_toc folder that is a copy of the source files for the website but with the toc removed. Adding no_toc in the URL for the deployed course removes the TOC, which makes it compatible with Leanpub and Coursera.

This "no toc" version is important for rendering the course on Coursera and Leanpub. There is a GHA section for rendering the "no toc" version: https://github.com/jhudsl/OTTR_Template/blob/main/.github/workflows/render-all.yml#L90

howardbaek commented 5 months ago

@larnsce just in case you are still interested, the development of OTTR in Quarto has started in this repo: https://github.com/fhdsl/ottr

larnsce commented 5 months ago

Thanks for the note. I am watching closely and am still interested. We teach on online class where this would come in really handy.

howardbaek commented 5 months ago

Thanks for the reply @larnsce. I am actively developing the Quarto version, so hopefully will have something to show soon.