From 455985f7ef2b29a0ff5b9ef7bc51429c936ae472 Mon Sep 17 00:00:00 2001 From: saberzero1 Date: Sun, 24 May 2026 17:23:04 +0200 Subject: [PATCH] docs: add Node.js requirement, footnotes, and Obsidian plugin support table - Add Node.js 22 prerequisite callout to installation guide - Document footnote support via GFM plugin - Add Obsidian community plugin support table (Dataview, Excalidraw, Leaflet) --- docs/features/Obsidian compatibility.md | 23 +++++++++++++++++++++++ docs/getting-started/installation.md | 3 +++ 2 files changed, 26 insertions(+) diff --git a/docs/features/Obsidian compatibility.md b/docs/features/Obsidian compatibility.md index 414b237..9750ca5 100644 --- a/docs/features/Obsidian compatibility.md +++ b/docs/features/Obsidian compatibility.md @@ -194,6 +194,29 @@ Video files can be embedded using standard image syntax: By default, Obsidian does not render its Markdown syntax inside HTML blocks. Quartz extends this with the `enableInHtmlEmbed` option, which parses wikilinks, highlights, and tags inside raw HTML nodes. +### Footnotes + +Footnotes using the `[^1]` syntax are fully supported through the [[GitHubFlavoredMarkdown]] plugin: + +```markdown +Here is a sentence with a footnote.[^1] + +[^1]: This is the footnote content. +``` + +## Obsidian Community Plugin Support + +Quartz focuses on supporting Obsidian's core features. Functionality from Obsidian community plugins is handled by Quartz community plugins: + +| Obsidian Plugin | Quartz Support | +| --------------- | -------------- | +| Dataview | Supported via [Quartz Syncer](https://community.obsidian.md/plugins/quartz-syncer) — exports Dataview queries as static content during sync | +| Excalidraw | Planned as a future community plugin | +| Leaflet Maps | Supported via the `obsidian-plugin-leaflet` community plugin | + +> [!tip] +> As a general rule: Obsidian core features are supported by Quartz directly, while Obsidian community plugin features are supported by corresponding Quartz community plugins. + ## Configuration This functionality is provided by the [[ObsidianFlavoredMarkdown]], [[Frontmatter]] and [[CrawlLinks]] plugins. See the plugin pages for customization options. diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 8949aa4..bba37b4 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -15,6 +15,9 @@ cd quartz ## 2. Install Dependencies +> [!important] +> Quartz requires **Node.js 22** or later. Check your version with `node -v` and upgrade at [nodejs.org](https://nodejs.org/) if needed. + ```bash npm i ```