quartz/docs/features/Roam Research compatibility.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

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. Since the markdown exported from Roam Research includes specific {{[[components]]}} and formatting that may not be directly compatible with Quartz, we need to transform it. This is achieved with the RoamFlavoredMarkdown plugin.

plugins: {
  transformers: [
    // ...
    Plugin.RoamFlavoredMarkdown(),
    Plugin.ObsidianFlavoredMarkdown(),
    // ...
  ],
},

Usage

By default, Quartz does not recognize markdown files exported from Roam Research as they contain unique identifiers and components specific to Roam. You are responsible for exporting your Roam Research notes as markdown files and then using this transformer to make them compatible with Quartz. This process ensures that your knowledge graph is seamlessly integrated into your static site, maintaining the rich interconnections between your notes.

Configuration

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

Note

As seen above placement of Plugin.RoamFlavoredMarkdown() within quartz.config.ts is very important. It must come before Plugin.ObsidianFlavoredMarkdown().