Quarto Demo

What does it do? Does it do things? Let’s find out! 🐴

Table of contents

• About
  • About Quarto
  • Examples
  • Output formats
  • Quarto vs. Jupyter ecosystem
  • Quarto vs. Jupyter notebooks
• Getting started
  • Installing
  • Working on a project
• Publish your project
  • GitHub Actions / GitHub Pages prep-work
  • GitHub Action workflow definition
• Quarto for QGreenland workshops
  • Relatively simple for non-technical users
• Fin

About

About Quarto

⌨️ Written in TypeScript.

❤️ Very responsive development team.

📤 Focused on publishing: websites, books, PDFs, slide decks.

✍️ Authoring in Markdown.

I’ve opened four issues with Quarto so far, and community has been extremely supportive. Two bugs were fixed right away, one bug was scheduled for a future milestone, and the fourth was user error.

Examples

• Performs computations (requires Jupyter dependency):

  import math
  math.tau > math.pi

  True

• Renders rich text:

  \[\large\tau > \pi\]

• Renders many output formats (like this slide deck!)

Output formats

• Documents
  • HTML
  • PDF
  • Word
  • OpenOffice
  • ePub
• Presentations
  • RevealJS (these slides)
  • PowerPoint
  • Beamer

• Markdown dialects
• Wikis
• Jupyter Notebooks
• Org-Mode
• Much more

Quarto vs. Jupyter ecosystem

• Quarto is focused on publishing to many formats (via Pandoc).
  • Competes with JupyterBook, which is less mature.
• Quarto uses Jupyter under the hood to perform computations.

Quarto vs. Jupyter notebooks

• Both are Literate Programming tools.
• Quarto uses Computational Markdown as its input format, so it’s easier to version-control.
• TODO: More!

Getting started

Installing

You can install Quarto from conda-forge:

conda install -c conda-forge quarto
mamba install -c conda-forge quarto

Or you can install from the official sources (Linux .deb/.tar.gz, Mac, Windows)

Warning

Use the official sources if you’re rendering to PDF. See the README of this repo for details!

Working on a project

Project Basics doc

Create a project

quarto create-project <project-name> --type=<website|book|default>

Render your project

Turn your markdown files into your desired output format(s).

quarto render

Preview your project

Render your project & serve it with a hot-reloading webserver!

quarto preview

Live demo this

Publish your project

GitHub Actions / GitHub Pages prep-work

GitHub Pages setup

For simplicity, I prefer to use the “GitHub Actions” method rather than the “Deploy from a branch” method to keep my repository history free of output artifacts.

GitHub Action workflow definition

Quarto provides out-of-the-box GitHub Actions you can use to publish for free to GitHub Pages.

• Great for basic use cases.
• You’ll need custom actions if your Quarto document(s) require third-party libraries.

Example

Quarto for QGreenland workshops

• Educator workshop

• Researcher workshop

Relatively simple for non-technical users

We set up the educator workshop GitHub repo with GitHub actions, then our team’s education expert set to work on creating a beautiful site through the GitHub web interface.

Fin

We’d love suggestions on how to best present Quarto to a non-developer audience.

Read more about caveats!