alrayyes/wiki
1
0
Fork 0
mirror of https://github.com/alrayyes/wiki.git synced 2024-11-22 19:46:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
wiki/docs/plugins/RoamFlavoredMarkdown.md
Matt Vogel d2414b3903
feat(markdown): Roam Research flavour (#985) 
* feat: Roam Research flavor markdown

* docs: Roam Research transformer

* use markdownPlugins

* fix roam matching

* cleanup: Roam Plugin

---------

Co-authored-by: Matt Vogel <>
2024-09-11 03:29:07 -04:00

1.4 KiB
Raw Blame History

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