Guide

Start with the basics of a Closeread document, then learn to master more advanced techniques.

If you’ve never made a Closeread document, copy and paste the following document into a qmd document.

myfirstcr.qmd

---
title: My First Closeread
format: closeread-html
---

Hello World! Please read my Closeread story below.

:::{.cr-section}

Closeread enables scrollytelling.

Draw your readers attention with focus effects. @cr-features

:::{#cr-features}
1. Highlighting
2. Zooming
3. Panning
:::

:::

In the same directory as this qmd file, run the following command to make the Closeread extension available to this document.

quarto add qmd-lab/closeread

Now you can render the document and scroll through your first scrollytelling story. Continue the adventure by reading about the Components of a Closeread Document.

When you’ve finished the Guide, be sure to have a look at the Gallery for more examples of what you can do with Closeread!

---

This is an open-source tool built upon other open-source tools. Closeread extends Quarto, a tool for technical publishing sponsored by Posit, PBC. The responsivity to user scrolling is made possible by the scrollama v3.0 JavaScript library by Russell Samora. Both tools are open-source and distributed under an MIT License.