Reference
Document Metadata
Document-wide options under the closeread-html
format key in YAML format.
debug-mode
layout
Fenced Div Options
Closeread takes advantage of the Pandocs’s fenced div syntax to pass options to sections, triggers, and stickies. The fenced div syntax allows you to wrap 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 > :::
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.
layout
Trigger Block Options
A trigger block is an element with the focus-on
attribute to trigger effects on a particular sticky element.
focus-on
Sticky Block Options
A sticky block is an element tagged with an identifier prefixed with cr-
.