Closeread
Closeread is a custom format for Quarto that enables scrollytelling features for HTML documents.
Getting started
Closeread is a custom format for Quarto that enables scrollytelling features for html documents.
Install the extension (or update it) 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
---
What’s next?
For guidance on how to author Closeread documents, read the Guide, starting with Components of a Closeread document. These components are the essential building blocks of scrollytelling with Closeread. Follow the rest of the Guide for ways to add more advanced effects.
Publishing
When you’re ready to let the world (or just a few people) see your work, check out the Quarto publishing section of the Guide. Closeread documents follow the same publishing rules as other Quarto documents, so if you’ve worked with Quarto before, you’re already already to go! Likewise, if you’ve published other static web pages before, you can take the files created by quarto render
and put them anywhere on the web.
Gallery and Reference
Need some inspiration? For examples of Closeread documents alongside their source, consult the Gallery to see how we made them. The Gallery also has examples that highlight particular features of Closeread.
If you can’t remember a particular option that Closeread uses, see the Reference.
Community
Need help, or looking for others to connect with around Closeread? Come join us on the discussion board or file an issue.
You can also install the development version of Closeread. It updates frequently and may break.
quarto add qmd-lab/closeread@dev
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.