From c98ef7e89f2c63d417d2c9ae364c56308f8501fc Mon Sep 17 00:00:00 2001
From: Aaron Pham <contact@aarnphm.xyz>
Date: Fri, 03 Jan 2025 19:27:43 +0000
Subject: [PATCH] perf(img): lazy load chunks (#1700)
---
docs/features/Roam Research compatibility.md | 16 +++++++---------
1 files changed, 7 insertions(+), 9 deletions(-)
diff --git a/docs/features/Roam Research compatibility.md b/docs/features/Roam Research compatibility.md
index aaeda8d..41ea885 100644
--- a/docs/features/Roam Research compatibility.md
+++ b/docs/features/Roam Research compatibility.md
@@ -4,7 +4,10 @@
- feature/transformer
---
-[Roam Research](https://roamresearch.com) 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.
+[Roam Research](https://roamresearch.com) 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.
```typescript title="quartz.config.ts"
plugins: {
@@ -17,14 +20,9 @@
},
```
-## Usage
+> [!warning]
+> As seen above placement of `Plugin.RoamFlavoredMarkdown()` within `quartz.config.ts` is very important. It must come before `Plugin.ObsidianFlavoredMarkdown()`.
-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
+## Customization
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()`.
--
Gitblit v1.10.0