quartz-community/roam
1
0
Fork 0
mirror of https://github.com/quartz-community/roam.git synced 2026-07-22 02:50:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
19 commits 1 branch 0 tags 141 KiB
TypeScript 100%
Find a file
saberzero1 56680bd78e
chore: set tsup platform to node 
Plugins run server-side during the Quartz build step, not in the
browser. Setting platform: 'node' tells esbuild to treat Node builtins
as available externals and avoids CJS-in-ESM require() failures for
any bundled dependencies that use Node APIs.
2026-03-17 20:41:14 +01:00
.github/workflows ci: add dist externals verification step 2026-03-17 19:41:48 +01: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 fix: centralize type declarations and add missing dependencies 2026-03-16 18:54:32 +01:00
package.json fix: bundle non-shared deps into dist to prevent runtime resolution failures 2026-03-17 19:31:51 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +01:00
tsconfig.json Initial commit 2026-02-13 21:36:13 +01:00
tsup.config.ts chore: set tsup platform to node 2026-03-17 20:41:14 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@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

Usage

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,
});

Configuration

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.

Documentation

See the Quartz documentation for more information.

License

MIT