Files
quartz/docs/plugins/RoamFlavoredMarkdown.md
saberzero1 f681e871ea docs: add missing options to transformer plugin documentation
- CreatedModifiedDate: add defaultDateType option
- Description: add maxDescriptionLength option
- Latex: add katexOptions, mathJaxOptions, typstOptions
- SyntaxHighlighting: add clipboard and tokenClassification options
- RoamFlavoredMarkdown: add tableComponent and attributeComponent
2026-05-22 20:07:48 +02:00

1.6 KiB

title, tags, image
title tags image
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.
  • tableComponent: If true (default), converts Roam table syntax into HTML tables.
  • attributeComponent: If true (default), converts Roam attribute syntax into rendered attributes.

API

  • Category: Transformer
  • Function name: ExternalPlugin.RoamFlavoredMarkdown().
  • Source: quartz-community/roam
  • Install: npx quartz plugin add github:quartz-community/roam