ELIXIREstonia (@elixirestonia.bsky.social)

Markdown-based course websites <p>Today I want to talk about three interesting frameworks for building course websites: Quarto, the Carpentries Workbench, and Nebula.</p> <p>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.</p> <table> <thead> <tr> <th><strong>Tool</strong></th> <th><strong>Documentation</strong></th> <th><strong>Templates</strong></th> </tr> </thead> <tbody> <tr> <td><strong>Quarto Websites / Books</strong></td> <td><a href="https://quarto.org/docs/websites/">Website Docs</a> / <a href="https://quarto.org/docs/books/">Book Docs</a></td> <td><a href="https://quarto.org/docs/websites/#quick-start">Website Template</a> / <a href="https://quarto.org/docs/books/#quick-start">Book Template</a></td> </tr> <tr> <td><strong>Carpentries Workbench</strong></td> <td><a href="https://carpentries.github.io/workbench/">Docs</a></td> <td><a href="https://github.com/carpentries/workbench-template-rmd">RMarkdown Template</a>, <a href="https://github.com/carpentries/workbench-template-md">Markdown Template</a></td> </tr> <tr> <td><strong>Nebula</strong></td> <td><a href="https://github.com/esciencecenter-digital-skills/NEBULA-docs/tree/main">Docs</a></td> <td><a href="https://github.com/esciencecenter-digital-skills/NEBULA">Template</a></td> </tr> </tbody> </table> <p>I have created course websites with Quarto before (see e.g. <a href="https://heidiseibold.com/2024/12/13/markdown-based-course-websites.html">here</a>), I’ve practiced a little with the Workbench, but Nebula is new to me. But let’s dive a little deeper into each.</p> <h2 id="quarto-websites-or-books">Quarto websites or books</h2> <p>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 <a href="https://quarto.org/docs/get-started/">install</a> 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.</p> <p><img alt="Quarto book example" src="https://heidiseibold.com/assets/images/posts/2024-12-06_quarto.png"/></p> <p>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 <a href="https://github.com/jonjoncardoso/quarto-template-for-university-courses">template for university courses</a>).</p> <p>Example courses:</p> <ul> <li><a href="https://berd-nfdi.github.io/BERD-reproducible-research-course/">Make Your Research Reproducible</a> (Quarto Book)</li> <li><a href="https://sta199-f24.github.io/">Introduction to Data Science and Statistical Thinking</a> (Quarto Website)</li> </ul> <h2 id="carpentries-workbench">Carpentries Workbench</h2> <p>The Workbench is first and foremost created for courses of <a href="https://carpentries.org/">The Carpentries</a>, but I’ve noticed that other initiatives and trainers use it for non-Carpentries courses. It was built using <a href="https://r-project.org">R</a> 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.</p> <p><img alt="Workbench example" src="https://heidiseibold.com/assets/images/posts/2024-12-06_workbench.png"/></p> <p>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.</p> <p>Example courses:</p> <ul> <li><a href="https://carpentries.github.io/lesson-development-training/">Collaborative Lesson Development Training</a> (with Carpentries design)</li> <li><a href="https://epiverse-trace.github.io/tutorials-middle/">Real-time analysis and forecasting for outbreak analytics with R</a> (non-Carpentries)</li> </ul> <h2 id="nebula">Nebula</h2> <p>I just learned about Nebula, which is developed by the <a href="https://www.esciencecenter.nl">eScience Center</a> in the Netherlands. It uses <a href="https://nuxtjs.org/">Nuxt.js</a> and <a href="https://vuejs.org/">Vue.js</a>.</p> <p><img alt="Nebula example" src="https://heidiseibold.com/assets/images/posts/2024-12-06_nebula.png"/></p> <p>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.</p> <p>Example courses:</p> <ul> <li><a href="https://esciencecenter-digital-skills.github.io/research-software-support/">Research Software Support</a></li> </ul> https://heidiseibold.com/2024/12/13/markdown-based-course-websites.html