Reference

Document Metadata

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

debug-mode

Toggle debug mode.

format
yaml
parent key
format:closeread-html
possible values
  • false (default)
  • true
layout

Define the relative positioning of the narrative and sticky columns in all sections in the document. Is overridden if a section specifies its own layout.

format
yaml
parent key
format:closeread-html:cr-section
possible values
  • sidebar-left (default)
  • sidebar-right
  • overlay-left
  • overlay-center
  • overlay-right
No matching items

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

Defines the relative positioning of the narrative and sticky columns. Overrides any layout set in the document metadata.

format
pandoc attribute
possible values
  • sidebar-left (default)
  • sidebar-right
  • overlay-left
  • overlay-center
  • overlay-right
No matching items

Trigger Block Options

A trigger block is an element with the focus-on attribute to trigger effects on a particular sticky element.

focus-on

Indicate which sticky block to focus on. Will transition to that block and use it in any focus effects.

format
pandoc attribute
possible values
  • {string} (default)
No matching items

Sticky Block Options

A sticky block is an element tagged with an identifier prefixed with cr-.

#cr-*

Identify an element as a sticky element.

format
pandoc identifier
possible values
  • #cr-* (default)
No matching items