quartz/docs/plugins/RoamFlavoredMarkdown.md

title	tags
RoamFlavoredMarkdown	plugin/transformer

This plugin provides support for Roam Research compatibility. See Roam Research Compatibility for more information.

Note

For information on how to add, remove or configure plugins, see the Configuration#Plugins page.

This plugin accepts the following configuration options:

• orComponent: If true (default), converts Roam {{ or:ONE|TWO|THREE }} shortcodes into HTML Dropdown options.
• TODOComponent: If true (default), converts Roam {{[[TODO]]}} shortcodes into HTML check boxes.
• DONEComponent: If true (default), converts Roam {{[[DONE]]}} shortcodes into checked HTML check boxes.
• videoComponent: If true (default), converts Roam {{[[video]]:URL}} shortcodes into embeded HTML video.
• audioComponent: If true (default), converts Roam {{[[audio]]:URL}} shortcodes into embeded HTML audio.
• pdfComponent: If true (default), converts Roam {{[[pdf]]:URL}} shortcodes into embeded HTML PDF viewer.
• blockquoteComponent: If true (default), converts Roam {{[[>]]}} shortcodes into Quartz blockquotes.

API

• Category: Transformer
• Function name: Plugin.RoamFlavoredMarkdown().
• Source: quartz/plugins/transformers/roam.ts.