Closeread

closeread is a custom format for Quarto that enables scrollytelling features for html documents.

Install the extension by running the following command in the directory you wish to use it:

quarto add qmd-lab/closeread

With the extension installed, you can author documents using the closeread-html format:

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

Get your first closeread doc up and running in four steps.

Step one: create a qmd file and set the format to closeread-html.

Step two: open up a closeread section.

Step three: flag an element to become a sticky.

Step four: create a trigger to make the sticky appear.

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: @cr-features

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

:::

For guidance on how to author closeread documents, read the Guide. For examples of closeread documents alongside their source, see the Gallery. For a catalog of the syntax and yaml options used in the closeread extension, see the Reference.