@quartz-community/obsidian-plugin-excalidraw 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-05-25
+
+### Added
+
+- Initial release as Excalidraw page-type plugin for Quartz v5.
+- Parse `.excalidraw.md` files (both `json` and `compressed-json` LZ-String formats).
+- Parse `.excalidraw` pure JSON files.
+- Synchronous SVG rendering using roughjs and perfect-freehand (no DOM, no native dependencies).
+- Support for rectangles, ellipses, diamonds, text, arrows (curved), freedraw, images, frames, and embeddable elements.
+- Embedded note transclusion via Quartz's wikilink resolver.
+- Embedded webpage rendering via sandboxed iframe.
+- Full dark/light mode theme support using CSS custom properties with pre-computed color mappings for all 65 Excalidraw palette colors.
+- Pan and zoom interaction (mouse drag, scroll wheel, buttons).
+- Full-viewport page frame with toggleable sidebar.
+- Filter integration preventing `.excalidraw.md` from being double-processed as Markdown.
+- 24 unit tests covering parser and renderer.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Quartz Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# @quartz-community/obsidian-plugin-excalidraw
+
+A page type plugin that renders [Obsidian Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin) 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
+
+```bash
+npx quartz plugin add github:quartz-community/obsidian-plugin-excalidraw
+```
+
+## Usage
+
+```yaml title="quartz.config.yaml"
+plugins:
+  - source: github:quartz-community/obsidian-plugin-excalidraw
+    enabled: true
+    options:
+      enableInteraction: true
+      darkMode: "auto"
+      exportPadding: 20
+```
+
+For advanced use cases, you can override in TypeScript:
+
+```ts title="quartz.ts (override)"
+import * as ExternalPlugin from "./.quartz/plugins";
+
+ExternalPlugin.ExcalidrawPage({
+  enableInteraction: true,
+  darkMode: "auto",
+  exportPadding: 20,
+});
+```
+
+## 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.
+
+## Configuration
+
+| Option              | Type      | Default  | Description                                                |
+| ------------------- | --------- | -------- | ---------------------------------------------------------- |
+| `enableInteraction` | `boolean` | `true`   | Whether to enable pan and zoom interaction on the drawing. |
+| `darkMode`          | `string`  | `"auto"` | Theme mode: `"auto"`, `"light"`, or `"dark"`.              |
+| `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](https://github.com/zsviczian/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.
+
+## License
+
+MIT

package/dist/components/index.d.ts

@@ -0,0 +1,6 @@
+import { QuartzComponent } from '@quartz-community/types';
+import { ExcalidrawPageOptions } from '../types.js';
+
+declare const _default: (userOpts?: ExcalidrawPageOptions) => QuartzComponent;
+
+export { _default as ExcalidrawBody };