mirror of https://github.com/quartz-community/roam.git synced 2026-07-22 02:50:27 +00:00

No description

Find a file

saberzero1 b2aad70fdf chore: regenerate package-lock.json		2026-05-24 17:33:02 +02:00
.github/workflows	build: bundle dependencies and ship pre-built dist	2026-04-27 21:38:23 +02:00
dist	fix: bundle non-shared deps into dist to prevent runtime resolution failures	2026-03-17 19:31:51 +01:00
src	fix: resolve ESLint and formatting issues for CI compliance	2026-03-09 03:47:21 +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: commit dist/ and remove prepare script	2026-03-14 22:01:20 +01: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	Initial commit	2026-02-13 21:36:13 +01:00
LICENSE	Initial commit	2026-02-13 21:36:13 +01:00
package-lock.json	chore: regenerate package-lock.json	2026-05-24 17:33:02 +02:00
package.json	chore: remove vestigial @jackyzha0/quartz peerDependency	2026-05-24 16:24:31 +02:00
README.md	docs: update README for v5 unified config system	2026-02-25 16:07:03 +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 github:quartz-community/roam

plugins:
  - source: github:quartz-community/roam
    enabled: true

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.RoamFlavoredMarkdown({
  orComponent: true,
  TODOComponent: true,
});

Option	Type	Default	Description
`orComponent`	`boolean`	`true`	Whether to enable the {{or:}} component.
`TODOComponent`	`boolean`	`true`	Whether to enable the TODO component.
`DONEComponent`	`boolean`	`true`	Whether to enable the DONE component.
`videoComponent`	`boolean`	`true`	Whether to enable the video component.
`audioComponent`	`boolean`	`true`	Whether to enable the audio component.
`pdfComponent`	`boolean`	`true`	Whether to enable the PDF component.
`blockquoteComponent`	`boolean`	`true`	Whether to enable the blockquote component.
`tableComponent`	`boolean`	`true`	Whether to enable the table component.
`attributeComponent`	`boolean`	`true`	Whether to enable the attribute component.

See the Quartz documentation for more information.

MIT