Markdown-based course websites


New frameworks for course websites are popping up all the time. In this post, I'll review some of them.

Today I want to talk about three interesting frameworks for building course websites: Quarto, the Carpentries Workbench, and Nebula.

All of them rely on the use of Markdown and are thus easy to version control, reproducible, and reusable. They’re all pretty handy when teaching software skills, as they allow incorporating code in a straight-forward way.

Quarto Websites / Books

Website Docs / Book Docs

Website Template / Book Template

Carpentries Workbench

Docs

RMarkdown Template, Markdown Template

Nebula

Docs

Template

I have created course websites with Quarto before (see e.g. here), I’ve practiced a little with the Workbench, but Nebula is new to me. But let’s dive a little deeper into each.

Quarto websites or books

Both Quarto websites and online books are easy to work with when you’ve worked with Quarto or RMarkdown before. You don’t need to install anything but Quarto unless you want to use it in combination with a programming languague or in combination with a tool that is not your pre-installed terminal.

I like that they provide a straight-forward structure and that a lot of people in my bubble know how to work with Quarto (so I can ask others to contribute, too). They are pretty enough, but I don’t think it’s easy to win a design price with Quarto course websites. Yet, they feel modern and are easy to use and mobile-ready out of the box. Quarto is flexible enough for my taste and you can even create your own adjusted templates (see Jon Cardoso-Silva’s template for university courses).

Example courses:

Carpentries Workbench

The Workbench is first and foremost created for courses of The Carpentries, but I’ve noticed that other initiatives and trainers use it for non-Carpentries courses. It was built using R and is based on three R packages: sandpaper, pegboard, and varnish. As such you need to install R and the three packages to use it.

The Workbench is perfect for courses in Carpentries style: ‘code with me’-courses where the instructor writes code on their machine and the learners code along. You can switch between learner and instructor view, where for the latter you can incorporate trainer notes.

Example courses:

Nebula

I just learned about Nebula, which is developed by the eScience Center in the Netherlands. It uses Nuxt.js and Vue.js.

The design is so nicely tied in with the eScience Center corporate design, that you don’t notice when you switch from their regular website to the training website. The project is a nice example that organisations can create their own Markdown-based flavoured course websites and fast. The project was only started in 2023 and looks quite nice. Even if it was clearly created for the eScience Center it is available under an Apache license, so you can reuse it if you like the style of these websites.

Example courses:

Hope this was a helpful post for your own course website ideas.

Interested in more helpful tips, free courses and more? Check out the DRAdvent calendar on the DRA social media channels!

Mastodon | LinkedIn | BlueSky

All the best,

Heidi

Let's connect!

Mastodon | LinkedIn | Website

Digital Research Academy

Mastodon | LinkedIn | Website

Heidi Seibold, Bayerstr. 77C, Munich, 80335
Unsubscribe · Preferences · My newsletters are licensed under CC-BY 4.0

Dr. Heidi Seibold

All things open and reproducible data science.

Read more from Dr. Heidi Seibold
Sketchnotes email course

Taking notes and drawing little images helps me think, but they are also helpful to others. Would sketchnoting also be for you? I started sketchnoting by taking notes about scientific presentations and meetings. They help me think and keep me focused on what is said. If used to find it very hard to concentrate during presentations and I found a couple of ways to focus on what is said and trying to really understand it. One of them is making myself come up with questions about the talk (a...

collaboration iceberg

Too many code projects in research are done by a single person. Keep reading on why that's bad and how to do better. It’s been a while since my last post. Founding the Digital Research Academy, holidays and LOTS AND LOTS of workshops and events have taken all my time. But it’s time to start writing again. One of the workshops I taught since my last post was on collaborative coding at the wonderful RSE summer school at KIT (click through the timetable to find all kinds of cool materials)....

Mel, Joyce, and Heidi at the notary

I am excited to share that the Digital Research Academy incorporation is almost done. We had our notary appointment last week, set up the bank account and are now waiting for the official registration of the DRA Digital Research Academy GmbH. I published my first post about the initial idea for the Digital Research Academy in May 2023. Now, just a year and a few months later, the Digital Research Academy is becoming not only an initiative but a company. Last week Joyce Kao, Melanie Imming and...