Quartz integration for Obsidian Excalidraw plugin by zsviczian.
  • TypeScript 84.5%
  • SCSS 15.5%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:03:52 +01:00
.changeset chore: version package 2026-11-09 04:06:49 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:27 +01:00
.sisyphus/plans fix: images, dark mode colors, heading anchors in embeds 2026-05-25 14:03:45 +02:00
src fix: drawings follow the site publish filters; Markdown drawings keep their frontmatter (bases-page#11) 2026-11-09 04:32:20 +01:00
test fix: drawings follow the site publish filters; Markdown drawings keep their frontmatter (bases-page#11) 2026-11-09 04:32:20 +01:00
types Initial commit 2026-05-25 00:29:38 +02:00
.eslintrc.json feat: implement Excalidraw page-type plugin for Quartz v5 2026-05-25 03:10:13 +02:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:23 +02:00
.prettierignore Initial commit 2026-05-25 00:29:38 +02:00
.prettierrc Initial commit 2026-05-25 00:29:38 +02:00
AGENTS.md Initial commit 2026-05-25 00:29:38 +02:00
ARCHITECTURE.md Initial commit 2026-05-25 00:29:38 +02:00
CHANGELOG.md chore: version package 2026-11-09 04:06:49 +00:00
EXAMPLES.md Initial commit 2026-05-25 00:29:38 +02:00
LICENSE Initial commit 2026-05-25 00:29:38 +02:00
package-lock.json chore: version package 2026-11-09 04:06:49 +00:00
package.json chore: version package 2026-11-09 04:06:49 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:49 +01:00
tsconfig.build.json Initial commit 2026-05-25 00:29:38 +02:00
tsconfig.json Initial commit 2026-05-25 00:29:38 +02:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:32 +01:00
vitest.config.ts Initial commit 2026-05-25 00:29:38 +02:00

@quartz-community/obsidian-plugin-excalidraw

A page type plugin that renders Obsidian Excalidraw drawings (.excalidraw.md and .excalidraw files) as full-page interactive SVG visualizations. Supports shapes, text, arrows, freedraw strokes, embedded notes with transcluded content, embedded webpages via iframe, and full dark/light theme adaptation using Excalidraw's color palette.

Installation

npx quartz plugin add @quartz-community/obsidian-plugin-excalidraw

Usage

plugins:
  - source: "@quartz-community/obsidian-plugin-excalidraw"
    enabled: true
    options:
      enableInteraction: true
      darkMode: auto
      exportPadding: 20

A drawing gets a page at its file's path (Drawings/Plan.excalidraw.md → /Drawings/Plan.excalidraw), using a full-page frame of its own (excalidraw). To use the standard three-column layout instead:

layout:
  byPageType:
    excalidraw:
      template: default

Features

  • Shapes: Rectangles, ellipses, and diamonds rendered with roughjs hand-drawn style, respecting fill styles (hachure, cross-hatch, solid), stroke styles (solid, dashed, dotted), and roughness levels.
  • Text: Multi-line text with Virgil (hand-drawn), Helvetica, and Cascadia font families. Supports alignment and vertical positioning.
  • Arrows and lines: Smooth curved paths for multi-point arrows with arrowhead markers. Straight lines for two-point connections.
  • Freedraw: Freeform strokes rendered via perfect-freehand with pressure simulation.
  • Images: Embedded images displayed from base64 data URLs stored in the drawing.
  • Embedded notes: Obsidian wikilink embeds ([[note]]) resolved and transcluded with rendered HTML content.
  • Embedded webpages: URL embeds rendered as sandboxed iframes with title bars.
  • Dark/light mode: Full theme support using CSS custom properties. All 65 Excalidraw palette colors have pre-computed dark-mode equivalents matching Excalidraw's own applyDarkModeFilter algorithm.
  • Pan and zoom: Mouse drag to pan, scroll wheel to zoom, with zoom in/out/reset buttons.
  • Full-viewport layout: Dedicated page frame with toggleable sidebar (matching canvas-page pattern).
  • Compressed JSON: Supports both json and compressed-json (LZ-String) formats from the Obsidian Excalidraw plugin.
  • Filter integration: Prevents .excalidraw.md files from being double-processed as regular Markdown pages. A drawing stored as Markdown keeps its frontmatter, so publish, draft, password and other filters apply to it as to a note (Quartz 5.1+).

Configuration

Option Type Default Description
enableInteraction boolean true Whether to enable pan and zoom interaction on the drawing.
darkMode string "auto" "auto" follows the site's light/dark mode; "light" or "dark" fix the drawing's background.
exportPadding number 20 Padding around the drawing content in pixels.

Supported file formats

.excalidraw.md (Obsidian format)

The primary format produced by the Obsidian Excalidraw plugin. Contains YAML frontmatter, text elements section, optional embedded files section, and the drawing data in a %%-delimited block as either json or compressed-json (LZ-String base64).

.excalidraw (Pure JSON)

Standard Excalidraw JSON format with type, version, elements, appState, and files fields.

Documentation

See the Quartz documentation for more information.

License

MIT