quartz/docs/features/Roam Research compatibility.md at v5

Files

saberzero1 ed0f27c05f fix: move ExternalPlugin overrides before loadQuartzConfig in quartz.ts docs

loadQuartzConfig() internally calls loadQuartzLayout() to build the
PageTypeDispatcher, which instantiates components. Plugin option overrides
must be registered before this happens. Updated quartz.ts and all doc
snippets that show the ExternalPlugin override pattern to place calls
before loadQuartzConfig(). Also updated OxHugo and Roam docs from stale
v4 plugins pattern to v5 override pattern.

2026-05-24 18:33:58 +02:00

1.2 KiB

Raw Permalink Blame History

title, tags

title

tags

Roam Research Compatibility

feature/transformer

Roam Research is a note-taking tool that organizes your knowledge graph in a unique and interconnected way.

Quartz supports transforming the special Markdown syntax from Roam Research (like {{[[components]]}} and other formatting) into regular Markdown via the RoamFlavoredMarkdown plugin.

plugins:
  - source: github:quartz-community/roam
    enabled: true
    order: 25 # must come before obsidian-flavored-markdown
  - source: github:quartz-community/obsidian-flavored-markdown
    enabled: true
    order: 30

For the TS override approach, place overrides before loadQuartzConfig() in quartz.ts:

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

ExternalPlugin.RoamFlavoredMarkdown()

Warning

In YAML, plugin execution order is controlled by the order field. Ensure roam has a lower order value than obsidian-flavored-markdown so it runs first.

Customization

This functionality is provided by the RoamFlavoredMarkdown plugin. See the plugin page for customization options.

1.2 KiB Raw Permalink Blame History

Customization

1.2 KiB

Raw Permalink Blame History