Quartz's default roam plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:08:55 +01:00
.changeset chore: version package 2026-11-09 22:07:56 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:27 +01:00
src fix: rewrite Roam syntax before parsing, so it works alongside ObsidianFlavoredMarkdown; __italic__ is italic 2026-11-09 23:05:43 +01:00
test fix: rewrite Roam syntax before parsing, so it works alongside ObsidianFlavoredMarkdown; __italic__ is italic 2026-11-09 23:05:43 +01:00
types fix: centralize type declarations and add missing dependencies 2026-03-16 18:54:32 +01:00
.eslintrc.json fix: centralize type declarations and add missing dependencies 2026-03-16 18:54:32 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:37 +02:00
.prettierignore fix: centralize type declarations and add missing dependencies 2026-03-16 18:54:32 +01:00
.prettierrc Initial commit 2026-02-13 21:36:13 +01:00
CHANGELOG.md chore: version package 2026-11-09 22:07:56 +00:00
LICENSE Initial commit 2026-02-13 21:36:13 +01:00
package-lock.json chore: version package 2026-11-09 22:07:56 +00:00
package.json chore: version package 2026-11-09 22:07:56 +00:00
README.md docs(readme): how Roam syntax is applied (before parsing, alongside OFM); deprecated options 2026-11-09 23:05:58 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Initial commit 2026-02-13 21:36:13 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:38:23 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/roam

Transforms Roam Research markdown syntax including {{or:}} selectors, TODO/DONE checkboxes, media embeds, and Roam-style highlights.

Installation

npx quartz plugin add @quartz-community/roam

Quartz's default configuration has a disabled entry for this plugin; set enabled: true to use it.

Usage

plugins:
  - source: "@quartz-community/roam"
    enabled: true
    order: 92
    options:
      orComponent: true
      TODOComponent: true

Configuration

Option Type Default Description
orComponent boolean true Convert {{or:ONE|TWO|THREE}} into a dropdown.
TODOComponent boolean true Convert {{[[TODO]]}} into an unchecked checkbox.
DONEComponent boolean true Convert {{[[DONE]]}} into a checked checkbox.
videoComponent boolean true Convert {{[[video]]:URL}} into an embedded video (YouTube links become an embed).
audioComponent boolean true Convert {{[[audio]]:URL}} into an embedded audio player.
pdfComponent boolean true Convert {{[[pdf]]:URL}} into an embedded PDF viewer.
blockquoteComponent boolean true Convert [[>]] text into a blockquote.
tableComponent boolean true Deprecated: never implemented, has no effect.
attributeComponent boolean true Deprecated: never implemented, has no effect.

Roam's ^^highlight^^ and __italic__ syntax is always converted (to a highlight and to emphasis).

How it works

The plugin rewrites Roam syntax in the Markdown source before it is parsed, so it works alongside ObsidianFlavoredMarkdown, which would otherwise read [[…]] as wikilinks and __x__ as bold. Code blocks, inline code and frontmatter are left as written. The bracket-less forms ({{TODO}}, {{DONE}}, {{video: URL}}) work too, and [[>]] inside a list item makes a quote in that item. With ObsidianFlavoredMarkdown's enableCheckbox on (the default config), the TODO/DONE checkboxes can be ticked like task-list items.

Documentation

See the Quartz documentation and Roam Research compatibility for more information.

License

MIT