Reference

Document Metadata

Document-wide options under the closeread-html format key in YAML format.

Closeread Component Options

Closeread takes advantage of the Pandocs’s fenced div and bracketed span syntax to pass options to sections, triggers, and stickies. The fenced div syntax allows you to wrap block content (a figure, a paragraph, etc) in a div and pass it one or more identifiers, classes, and attributes.

:::{#myid .myclass myattribute="something"}
< block content like a figure or paragraph >
:::

The bracketed span allows you to wrap inline content (a word or phrase, a citation, etc) in a span and pass the same information.

Hello world [@cr-hello]{#myid .myclass myattribute="something"}

Identifiers start with #; classes start with ., and attributes have a key / value pair separated by = and no spaces. You can assign to a div one or more of each of these (though they must be supplied in identifier-class-attributes order) as long as each is separated by a space.

Section Options

A closeread section is a div with the class cr-section that contains stickies and triggers.

Sticky Options

A sticky block is a fenced div tagged with an identifier prefixed with cr-.

Trigger Block Options

A trigger block is a div with the focus-on attribute to trigger effects on a particular sticky element. Paragraphs allow the use of the citation syntax (@cr-mysticky) as a shortcut to wrap the paragraph in a div with the focus-on attribute.

Keyboard Hotkeys

While viewing a closeread document in a browser, you can press certain hotkeys to toggle features.

Hotkey	Effect
PP	Toggle presentation mode
forward-arrowforward-arrow	Scroll to next trigger
back-arrowback-arrow	Scroll to previous trigger